CHAPTER 6

image

Documenting REST Services

In this chapter we will discuss:

  • 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, Swagger 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 have historically relied on manually edited documents to expose REST contracts to clients. ...

Get Spring REST now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.