Hands-On RESTful Web Services with ASP.NET Core 3

Implementing the Swagger project

Just like the OpenAPI Specification, Swagger was born as a language-agnostic specification for describing REST APIs. It has recently been adopted by the OpenAPI project, which means there are no differences between these two projects.

The main aim of Swagger is to autogenerate and expose a document called swagger.json, also known as the Swagger Specification. The Swagger Specification is the autogenerated documentation of the API and provides information about every single route that's exposed by the web services. The following code shows the structure of an example swagger.json file:

{  "x-generator": "NSwag v12.0.12.0 (NJsonSchema v9.13.15.0 (Newtonsoft.Json v12.0.0.0))",  "swagger": "2.0",  "host": "localhost:5000" ...