domaindrivendev/Swashbuckle.AspNetCore

Features

• ASP.NET Core API Documentation - Provides the primary capability of generating machine-readable OpenAPI specifications and interactive browser interfaces directly from ASP.NET Core source code.
• OpenAPI Specification Generators - Automatically derives industry-standard OpenAPI specifications from ASP.NET Core routes and models.
• API Documentation Generators - Automatically generates technical documentation for multiple API versions and endpoint collections.
• Parameter Metadata Annotations - Defines descriptions and requirement flags for path, query, and header parameters to clarify input expectations.
• Operation Metadata Annotations - Allows the addition of summaries, descriptions, and tags to endpoints using attributes to enrich the generated documentation.
• OpenAPI Specification Generators - Generates standardized JSON OpenAPI documents from code metadata and comments for use by external tools.
• Specification Delivery Endpoints - Serves generated OpenAPI documents as serialized JSON endpoints for consumption by other tools.
• XML Documentation Comments - Extracts descriptions and examples from .NET XML code comments to enrich the machine-readable API specification.
• Attribute-to-Specification Mapping - Maps custom C# attributes to specific OpenAPI specification fields to enrich endpoint documentation.
• Runtime Schema Derivation - Analyzes types and attributes at runtime to automatically derive API specifications from source code.
• Schema Metadata Annotations - Defines property descriptions, formats, and requirement constraints for classes and properties within the data schema.
• API Metadata Enrichment - Uses custom attributes or filters to add detailed descriptions, examples, and security requirements to the documentation.
• API Documentation Tools - Functions as a comprehensive tool for generating, managing, and serving standardized API documentation and schema definitions.
• Global API Metadata - Provides a way to define high-level API information such as terms of service, contact details, and licensing.
• Interactive API Documentation UIs - Ships an embedded middleware that hosts interactive web interfaces for browsing and testing API endpoints.
• Request Body Documentation - Adds descriptive metadata and requirement constraints to the request body of an operation to specify input needs.
• UI Middleware Hosting - Integrates an interactive documentation interface directly into the request pipeline as embedded middleware.
• Annotated Response Models - Defines expected HTTP response codes and their corresponding data types using attributes to document output.
• API Attribute Filters - Omits specific operations or obsolete properties from the final API specification based on attributes or conventions.
• Targeted Schema Filtering - Executes custom logic to modify the schema of specific types instead of applying changes to all schemas.
• Operation Identifier Customization - Assigns unique identifiers to endpoints via custom strategies to facilitate the generation of client libraries.
• API CI/CD Integrations - Provides a command-line utility for extracting API specifications from assemblies to automate documentation in CI/CD pipelines.
• API Operation Tagging - Enables the addition of human-friendly descriptions to tags used for grouping API operations.
• Assembly-Based Specification Export - Bootstraps the application startup assembly in headless mode to write specifications to files for build pipelines.
• CLI Specification Exporters - Provides a command line interface to extract API specifications directly from a startup assembly.
• Custom Type Schema Mappings - Overrides the default schema generation for specific types to accurately reflect custom serialization behavior.
• Schema Identifier Strategies - Resolves naming conflicts for complex types by applying custom strategies to generate unique IDs.
• Security Scheme Documentation - Documents authentication and authorization requirements, such as OAuth2 and API keys, within the API specification.
• API Contract Definitions - Defines formal structures for API interfaces to ensure consistent communication between services.
• Polymorphic Schema Mapping - Specifies known subtypes and discriminator properties for base classes to support inheritance in the API schema.
• Filter-Based Logic Extensions - Provides a series of customizable interceptor filters to modify operations and schemas during generation.
• OpenAPI Specification Extraction - Processes application assembly reflection and metadata to extract and write OpenAPI specification files.
• API Metadata Filters - Implements a custom filter pipeline to modify operation and schema metadata during the generation process.
• API Schema Verifications - Verifies that the actual API behavior conforms to the defined OpenAPI specification.
• Multi-Document Hosting - Renders multiple specification endpoints in the UI to allow users to toggle between different versions.
• Operation Grouping and Sorting - Customizes tags and sort order of operations to control how they are grouped in the documentation interface.
• UI Configurations - Provides middleware options and custom templates to customize the appearance and behavior of the documentation interface.
• Middleware - Integrates as middleware to serve API specifications and interactive user interfaces directly from the running application.
• Dynamic Specification Modifications - Allows the generated API specification to be altered at runtime based on the incoming HTTP request.
• API Development - Integrates Swagger documentation into Web API projects.
• Core .NET Libraries - Tooling for generating Swagger documentation for web APIs.

سجل النجوم