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

Introduction of RESTful Web Service

Image
Rest Web Service It Stands for Representational State Transfer who coined Rest ?  Roy Fielding, who is developed HTTP as well Rest is make Best use of HTTP: Key Abstraction - Resources: 1. A Resource has an URI (Uniform Resource Identifier)     /user/Khan/todos/1     /user/Khan/todos     /user/Khan Note: It shows we  assign a URI to Each Resource           Rest does not worry about how you are representing your  resource            is it JSON,XML or HTML 2. A Resource can have different representations     JSON     XML     HTML Methods for Resources: 1. Create Resource   : POST 2. Update Resource  : PUT 3. Get Resource        : GET 4. Delete Resource   : DELETE REST Data Exchange Format No Restriction.(But JSON format is popular in restful) Transport Only HTTP (Restricted) Service Definition No Standard (but Swagg...
Read more

Learn JPA and Hibernate

Image
https://start.spring.io/ in given above URL can   User Given Below Configuration to Create Spring Boot Project with given dependencies to enable JPA and Hibernate Spring Web Spring Data JDBC Spring Data JPA H2 Database < dependencies >      < dependency > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-data-jdbc</ artifactId >      </ dependency >      < dependency > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-data-jpa</ artifactId >      </ dependency >      < dependency > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-web</ artifactId >      </ dependency >      < dependency > < groupId >com.h2database</ groupId > < artifactId...
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