Tuesday, 29 March 2022

Spring Rest and Open API tutorial

In this tutorial series, I am going to explain, how to document REST APIs using Open API specification.

 

      Hello world application
      Customize API Documentation path
      Document request headers
      Document allowable values of a request header
      Document request header with examples
      Document request headers using @Operation annotation
      Document query parameter
      Document allowable values to the query parameter
      Document query parameters using Operation annotation
      Document path variable
      Document allowable values of a path variable
      Document path variables using @Operation annotation
      Enable Authorize button in openAPI to support Bearer token
      openAPI: Enable bearer token authentication scheme at method level
      Enable authorize button for Basic authentication
      How to get API documentations?
      Attach tag to a rest controller
      Document rest API description
      Document api responses
      APIKEY security scheme example
      Define API server host and base url
      Document project contact details
      Refer external documentation
      Document request parameters (headers, query, cookie, path variables) using Operation annotation
      Hide a rest api from documentation
      Document project license
      Document request payload
      Document array or list of objects as request payload
      Document array or list response

Reference

https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations#license

Previous                                                    Next                                                    Home

No comments:

Post a Comment