Configuration Auto Generation of Swagger Documentation

 Rest API Documentation - Swagger and Open API


  • 2011: Swagger Specification  and tool were Introduces
  • 2016: Open API Specification Created based on Swagger Specification
    • But Still Swagger tool was exists
  • OpenAPI Specification: this was earlier known as Swagger Specification, this is nothing but  a standard language agnostic interface, to define your Rest API, you can see an open api specification in given below screenshot with openApi 3.0.0 version

  • Swagger UI: Visualize and interact with your REST API
Note: springdoc-openapi java library helps to automate the genration of API documentation for Spring boot Projects

Given below dependancy is use for OpenApi

<dependency>

<groupId>org.springdoc</groupId>

<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>

<version>2.1.0</version>

</dependency>



once added given above dependancy you can able to access swagger UI documentation by given below URL


http://localhost:8080/swagger-ui/index.html

Given Below you can see the documentation for Our Rest API
  • as you can see number of controller classes which we have created is now you can seen in the UI form
  • also there GET POST DELETE and all the different Api End point urls



Previous
Next

Comments

Post a Comment

Popular posts from this blog

Step 1 Rest With Spring Boot

Image
How to Build Rest API  Identify Resources: (/user, /user/{id})  etc.  Identify Actions (GET, POST, PUT, DELETE, PATCH etc.)  Defining Request and Response Structure  Define  Response Status( 200 as Ok, 404 as Page Not Found, 500 Internal Server Error)     400 Series Errors:  Client Side Error     500 Series Errors:  Server Side Error  Best Practices for Rest API 1.Thinking on Consumer Perspective 2. validation  3  Internationalizations -i18n 4. Exception Handling 5. HATEOAS 6. Versioning 7. Documentation  8. Content Negotiation etc.  Internal Working of Spring Boot 1.   How to Handle Request in Spring Boot? Dispatcher Servlet- Front Controller Pattern Mapping Servlets: dispatcher Servlet urls=[/]  ( as dispatcher servlet is mapped to the [/] root URL)   If you search for Mapping servlets you will find out the given below string in logs which is telling to you dispatcher servlet is ma...
Read more

Implementing Dynamic Filtering for Rest API

 Implementing Static Filtering for Rest API Dynamic Filtring: Customize filtering for a bean for specific REST Api @Jsonfilter with filter Provider At Conroller class //********************** DYNAMIC FILTERING***********// @ GetMapping ( "/Dyfiltering" ) public MappingJacksonValue dynamicFiltering() { SomeBean someBean = new SomeBean( "val1" , "val2" , "val3" ); MappingJacksonValue mappingJacksonValue = new MappingJacksonValue( someBean ); SimpleBeanPropertyFilter filter = SimpleBeanPropertyFilter. filterOutAllExcept ( "field1" , "field2" ); SimpleFilterProvider filters = new SimpleFilterProvider().addFilter( "SomeBeanFilter" , filter ); mappingJacksonValue .setFilters( filters ); return mappingJacksonValue ; } //********************** DYNAMIC FILTERING***********// At Pojo Entity Class @JsonFilter ( "SomeBeanFilter" ) public class SomeBean { private String field...
Read more

How to User Path variable

  How to User Path variable @ PathVariable   is used for add the variable in the path of your URL and use into the code  @RestController @RequestMapping (path = "/by" ) public class ByWorldController { @GetMapping (path = "/hello-world/path-variable/{name}/{gender}" ) public HelloWorldBean helloWorldPathVariable( @PathVariable String name , @PathVariable String gender ) {          if ( gender . equalsIgnoreCase ( "m" )) {                  return new HelloWorldBean(String. format ( "Hello Mr %s" , name ));          } else if ( gender . equalsIgnoreCase ( "f" )) {                  return new HelloWorldBean(String. format ( "Hello Mrs %s" , name ));          }  ...
Read more