Spring boot: Documenting an Microservices using Swagger
Today I would like to share simple but helpful concept for documenting an API using swagger. In traditional approach people are creating a document to to show API detail. We are facing multiple issue in approach like
- We need to change a document if API changed.
- For very large project it would be hard to manage n number of services.
We have library available for better API documentation and which overcome above issues.
What is swagger
The Java based library called swagger which is provided by SpringFox will help us to create API documentation.
Official Swagger Git is : https://github.com/swagger-api
You just need to make small changes to some files to enable swagger.
Let’s look all of them in detail.
You can clone repository from below git.
GitHub Repo: https://github.com/yogeshmprajapati/kode12-spring-boot.git
Git Module: spring-boot-document-microservice-swagger
pom.xml
Add following dependency in you pom.
|
1 2 3 4 5 6 7 8 9 10 |
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency> |
EmployeeController.java
Sample controller to show how swagger interpret methods.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
package com.kode12.controller; import com.kode12.vo.EmployeeVO; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; import java.util.List; @RestController @RequestMapping("/employee") public class EmployeeController { @RequestMapping(value = "/", method = RequestMethod.GET) public List<EmployeeVO> getAll(){ return null; } @RequestMapping(value = "/{employeeId}", method = RequestMethod.GET) public EmployeeVO getById(@PathVariable("employeeId") long employeeId){ return null; } } |
SpringBootDocumentMicroserviceSwaggerApplication.java
Class having main method to run an application.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
package com.kode12; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Bean; import org.springframework.web.client.RestTemplate; import springfox.documentation.swagger2.annotations.EnableSwagger2; @SpringBootApplication @EnableSwagger2 public class SpringBootDocumentMicroserviceSwaggerApplication { public static void main(String[] args) { SpringApplication.run(SpringBootDocumentMicroserviceSwaggerApplication.class, args); } } |
The notifiable thing here is @EnableSwagger2, this annotation is required to enable swagger for current application and swagger will scan all web services signatures and populate it using swagger-ui.
Run an application
Run your application using main method and hit URL below to your favorite browser.
http://localhost:8080/swagger-ui.html
You will get the output as shown in below screenshot.
Here, it shows all exposed controller, one(basic-error-controller) which is exposed by spring and employee-controller is created by us.
Once we click on employee-controller, it shows all methods created in particular controller with details like URI pattern, return type, method name etc.
Once we click on second method (/employee/{employeeId}) it shows sample response value and also provide a view to test particular service.
That’s it about Swagger, SpringFox will provide multiple modules to do more with our application. I will cover some of them in upcoming posts.
Share current post by copy: https://goo.gl/UjwVF3
Happy Learning!
Thanks,
Yogesh P
Your simplistic information is very useful.