O'Reilly logo

Spring REST by Sudha Belida, Balaji Varanasi

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

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. ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required