Swagger/OpenAPI

Swagger Optional

If desired, you can add a basic swagger configuration using the SwaggerConfig option. This will scaffold out a bare bones swagger pager using NSwag, which you can update to use any additional features you wish.

To get to your swagger page, you can go to /swagger.

Swagger Properties

NameRequiredDescriptionDefault
TitleYesThe title of the swagger documentNone
DescriptionNoThe description for your swagger docNone
ApiContactNoThe primary contact for the APINone

ApiContact Properties

NameRequiredDescriptionDefault
NameNoThe name of the contactNone
EmailNoThe email of the contactNone
UrlNoThe website for the contactNone

Example

SwaggerConfig:
  Title: MySwaggerDoc
  Description: This is the official swagger doc for my amazing company.
  ApiContact: 
    Name: Paul
    Email: paul@example.com
    Url: https://www.mywebsite.com