dotnet-api-swagger

A dotnet 5 swagger setup project

Libraries Used

• Swashbuckle.AspNetCore
  • Swashbuckle.AspNetCore.Swagger
    • Exposes Swagger JSON endpoints.
  • Swashbuckle.AspNetCore.SwaggerGen
    • Generates OpenApiDocument(s) from your routes, controllers and models
  • Swashbuckle.AspNetCore.SwaggerUI
    • Exposes an embedded version of the swagger-ui
• Swashbuckle.AspNetCore.Annotations
  • Provides Custom attributes which helps in better documentation
• Swashbuckle.AspNetCore.ReDoc
  • Exposes an embedded version of the ReDoc documentation

API documentation Tools

• Swagger UI
• NSwag
• ReDoc

Tools for Open API Specification

• Swagger Hub ( Swagger Editor)
  • Write the Open API Specification by looking at the generated UI. Also helps to create Client/Server code.
• Postman
  • Add details in Postman & Click Publish Documentation for a collection, it will generate the documentation

Running the Project

• Download the Project
• Run the Project

Documentations

Swagger UI

http://localhost:3592/swagger

Redoc UI

http://localhost:3592/docs