/Swagger-Net

Seamlessly adds a swagger to WebApi projects!

Primary LanguageC#BSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Swagger-Net

Seamlessly add Swagger to WebApi projects! Combines ApiExplorer and Swagger/swagger-ui(3.x) to provide a rich discovery, documentation and playground experience to your API consumers.

In addition to its Swagger generator, Swagger-Net also contains an embedded version of swagger-ui which it will automatically serve up once Swagger-Net is installed. This means you can complement your API with a slick discovery UI to assist consumers with their integration efforts. Best of all, it requires minimal coding and maintenance, allowing you to focus on building an awesome API!

Swagger-Net Features:

  • Latest and greatest of all dependencies
  • High UnitTest CodeCoverage (99%)
  • Auto-generated Swagger 2.0
  • Seamless integration of swagger-ui (3.x)
  • Reflection-based Schema generation for describing API types
  • Extensibility hooks for customizing the generated Swagger doc and the swagger-ui
  • Out-of-the-box support for Xml comments

And that's not all ...

Once you have a Web API that can describe itself in Swagger, you've opened the treasure chest of Swagger-based tools including a client generator that can be targeted to a wide range of popular platforms. See swagger-codegen for more details.

Getting Started

Troubleshooting

Customizing the swagger-ui

Troubleshooting and FAQ's