-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
WebApiOpenApiDocumentGeneratorSettings
Rico Suter edited this page Oct 5, 2020
·
8 revisions
- Package: NSwag.Generation.WebApi
- Type: NSwag.Generation.WebApi.WebApiOpenApiDocumentGeneratorSettings
- Settings for: WebApiOpenApiDocumentGenerator
List of all setting properties:
- WebApiOpenApiDocumentGeneratorSettings inherits from
- OpenApiDocumentGeneratorSettings inherits from
- JsonSchemaGeneratorSettings (from the NJsonSchema project)
Document
- Title: The Swagger document title
- Description: The Swagger document description
-
Version: The API version (default:
1.0.0)
Web API specific
-
DefaultUrlTemplate (default:
api/{controller}/{id})
Extension points
- OperationProcessors: Processors to customize the Swagger generation of Web API operations (see Document Processors and Operation Processors)
- DocumentProcessors: Processors to postprocess the generated Swagger specification (see Document Processors and Operation Processors)
Templating
- DocumentTemplate