© Balaji Varanasi and Maxim Bartkov 2022
B. Varanasi, M. BartkovSpring RESThttps://doi.org/10.1007/978-1-4842-7477-4_6

6. Documenting REST Services

Balaji Varanasi1   and Maxim Bartkov2
(1)
Salt Lake City, UT, USA
(2)
Kharkov, Ukraine
 
In this chapter we will discuss the following:

  • The basics of Swagger

  • Using Swagger for API documentation

  • Customizing Swagger

Documentation is an important aspect of any project. This is especially true for enterprise and open-source projects, where many people collaborate to build the project. In this chapter, we will look at Swagger, a tool that simplifies REST API documentation.

Documenting a REST API for consumers to use and interact with is a difficult task because there are no real established standards. Organizations ...

Get Spring REST: Building Java Microservices and Cloud Applications 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.

Start your free trial