HAKOM.Documentation.Http.Net.Api.Extensions Namespace
Provides extension methods for adding and configuring automatically generated OpenAPI documentation.
Remarks
Section titled “Remarks”The extension methods in this namespace target ASP.NET Core builder types to register Swagger generation, configure routing for generated specification documents and register operation filters for custom model binder documentation.
- MvcBuilderExtensions – core setup: registers Swagger generation, XML comments, tag descriptions and the documentation controller.
- SwaggerGenOptionsExtensions – adds operation filters for parameters bound by custom model binders.
- WebApplicationExtension – configures routing for the generated specifications and Swagger UI.
mvcBuilder.AddDocumentation( title: "My API", description: "Manages time series.");
application.UseDocumentation();| Classes | |
|---|---|
| MvcBuilderExtensions | Contains methods for adding documentation functionality to an MVC framework based web service. |
| SwaggerGenOptionsExtensions | Provides extension methods on Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions for non-trivial modification of generated OpenAPI documents. |
| WebApplicationExtension | Provides extension methods for adding automatically generated OpenAPI documentation to an MVC framework based HTTP API. |
Was this page helpful?Thanks for your feedback!