11 API documentation
This chapter covers
- Identifying potential users of a web API
- Applying API documentation best practices in Swagger and Swashbuckle
- Using Extensible Markup Language (XML) documentation and Swashbuckle annotations
- Customizing the swagger.json file by using Swashbuckle’s filter pipeline
In chapter 1, when we tried to define an application programming interface (API), we referred to it as a software platform that exposes tools and services that different computer programs can use to interact by exchanging data. Starting from this definition, we could say that the purpose of an API (including a web API) is to create a common place where independent and often-unrelated systems can meet, greet, and communicate by using a commonly ...
Get Building Web APIs with ASP.NET Core now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
