Skip to content

engine-bay/api-documentation

Repository files navigation

EngineBay.ApiDocumentation

NuGet version Maintainability Test Coverage

ApiDocumentation module for EngineBay published to EngineBay.ApiDocumentation on NuGet.

About

This module will add middleware to generate and expose Swagger UI documentation for all the endpoints in your project. Swagger uses the OpenAPI 3 specification.

Usage

The Swagger documentation is generated entirely automatically if this module is enabled.

If you wish to browse the documentation generated for your project, you can start the application and visit /swagger/index.html.

Registration

This module cannot run on its own. You will need to register it in your application to use its functionality. See the Demo API registration guide.

Environment Variables

See the Documentation Portal.

Dependencies