Swashbuckle.AspNetCore.SwaggerGen
This service will be looked up by name from the service collection when using
the dotnet-getdocument tool from the Microsoft.Extensions.ApiDescription.Server package.
Define one or more documents to be created by the Swagger generator
A URI-friendly name that uniquely identifies the document
Global metadata to be included in the Swagger output
Provide a custom strategy for selecting actions.
A lambda that returns true/false based on document name and ApiDescription
Ignore any actions that are decorated with the ObsoleteAttribute
Merge actions that have conflicting HTTP methods and paths (must be unique for Swagger 2.0)
Provide a custom strategy for assigning "operationId" to operations
Provide a custom strategy for assigning a default "tag" to operations
Provide a custom strategy for assigning "tags" to actions
Provide a custom strategy for sorting actions before they're transformed into the Swagger format
Provide a custom comprarer to sort schemas with
Describe all parameters, regardless of how they appear in code, in camelCase
Provide specific server information to include in the generated Swagger document
A description of the server
Add one or more "securityDefinitions", describing how your API is protected, to the generated Swagger
A unique name for the scheme, as per the Swagger spec.
A description of the scheme - can be an instance of BasicAuthScheme, ApiKeyScheme or OAuth2Scheme
Adds a global security requirement
A dictionary of required schemes (logical AND). Keys must correspond to schemes defined through AddSecurityDefinition
If the scheme is of type "oauth2", then the value is a list of scopes, otherwise it MUST be an empty array
Provide a custom mapping, for a given type, to the Swagger-flavored JSONSchema
System type
A factory method that generates Schema's for the provided type
Provide a custom mapping, for a given type, to the Swagger-flavored JSONSchema
System type
A factory method that generates Schema's for the provided type
Generate inline schema definitions (as opposed to referencing a shared definition) for enum parameters and properties
Provide a custom strategy for generating the unique Id's that are used to reference object Schema's
A lambda that returns a unique identifier for the provided system type
Ignore any properties that are decorated with the ObsoleteAttribute
Enables composite schema generation. If enabled, subtype schemas will contain the allOf construct to
incorporate properties from the base class instead of defining those properties inline.
Enables polymorphic schema generation. If enabled, request and response schemas will contain the oneOf
construct to describe sub types as a set of alternative schemas.
To support polymorphism and inheritance behavior, Swashbuckle needs to detect the "known" subtypes for a given base type.
That is, the subtypes exposed by your API. By default, this will be any subtypes in the same assembly as the base type.
To override this, you can provide a custom selector function. This setting is only applicable when used in conjunction with
UseOneOfForPolymorphism and/or UseAllOfForInheritance.
If the configured serializer supports polymorphic serialization/deserialization by emitting/accepting a special "discriminator" property,
and UseOneOfForPolymorphism is enabled, then Swashbuckle will include a description for that property based on the serializer's behavior.
However, if you've customized your serializer to support polymorphism, you can provide a custom strategy to tell Swashbuckle which property,
for a given type, will be used as a discriminator. This setting is only applicable when used in conjunction with UseOneOfForPolymorphism.
If the configured serializer supports polymorphic serialization/deserialization by emitting/accepting a special "discriminator" property,
and UseOneOfForPolymorphism is enabled, then Swashbuckle will include a mapping of possible discriminator values to schema definitions.
However, if you've customized your serializer to support polymorphism, you can provide a custom mapping strategy to tell Swashbuckle what
the discriminator value should be for a given sub type. This setting is only applicable when used in conjunction with UseOneOfForPolymorphism.
Extend reference schemas (using the allOf construct) so that contextual metadata can be applied to all parameter and property schemas
Enable detection of non nullable reference types to set Nullable flag accordingly on schema properties
Automatically infer security schemes from authentication/authorization state in ASP.NET Core.
Provide alternative implementation that maps ASP.NET Core Authentication schemes to Open API security schemes
Currently only supports JWT Bearer authentication
Extend the Swagger Generator with "filters" that can modify Schemas after they're initially generated
A type that derives from ISchemaFilter
Optionally inject parameters through filter constructors
Extend the Swagger Generator with "filters" that can modify Parameters after they're initially generated
A type that derives from IParameterFilter
Optionally inject parameters through filter constructors
Extend the Swagger Generator with "filters" that can modify RequestBodys after they're initially generated
A type that derives from IRequestBodyFilter
Optionally inject parameters through filter constructors
Extend the Swagger Generator with "filters" that can modify Operations after they're initially generated
A type that derives from IOperationFilter
Optionally inject parameters through filter constructors
Extend the Swagger Generator with "filters" that can modify SwaggerDocuments after they're initially generated
A type that derives from IDocumentFilter
Optionally inject parameters through filter constructors
Inject human-friendly descriptions for Operations, Parameters and Schemas based on XML Comment files
A factory method that returns XML Comments as an XPathDocument
Flag to indicate if controller XML comments (i.e. summary) should be used to assign Tag descriptions.
Don't set this flag if you're customizing the default tag for operations via TagActionsBy.
Inject human-friendly descriptions for Operations, Parameters and Schemas based on XML Comment files
An absolute path to the file that contains XML Comments
Flag to indicate if controller XML comments (i.e. summary) should be used to assign Tag descriptions.
Don't set this flag if you're customizing the default tag for operations via TagActionsBy.
Generate polymorphic schemas (i.e. "oneOf") based on discovered subtypes.
Deprecated: Use the \"UseOneOfForPolymorphism\" and \"UseAllOfForInheritance\" settings instead