Add in Pom.xml file
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency>
Add an annotation to the Springboot entry method
@EnableSwagger2
Initiate system access
http://localhost:8080/swagger-ui.html
Related Comments
Add input parameter description information: @ApiModelProperty(value = "User age starting value") Add return parameter description information: @ApiModelProperty(value = "username") Add method name description information: @ApiOperation(value = "User query service") Add description to pathVariable: @ApiParam("user id")
For more information see: https://swagger.io/docs/