Hands-On Full-Stack Web Development with ASP.NET Core

Making your APIs discoverable and self-documenting with the OpenAPI standard (Swagger)

When discussing Web APIs, you need to consider that the users that will interact with your API are developers, and not the end users of the product. The developers that use your API can use it in a variety of clients that can be written in various programming languages and technologies. Even though you created a REST API that uses standards such as HTTP and JSON, there are still things that are not standardized, such as the date-time format you use, numbers accuracy, and so on. Besides this, developers who want to use your API need a way to find out which data structures your API works with; what the URL structure is; what type of errors are returned from ...