1.添加swagger2 依赖
<!--swagger2-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.1</version>
</dependency>
2.添加swagger 配置
package com.test.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import org.springframework.context.annotation.Bean;
import javax.swing.text.Document;
import java.util.ArrayList;
import java.util.List;
@EnableSwagger2
@Configuration
public class Swagger2 {
@Bean
public Docket createRestApi(){
List<Parameter> param = new ArrayList<Parameter>();
return new Docket (DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
.build()
.globalOperationParameters(param)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("生死迷踪")
.description("springboot")
.termsOfServiceUrl("https://blog.csdn.net/lwlcoco/article/details/103131940")
.version("1.1")
.build();
}
}
3.给接口添加注释
package com.test.web;
import com.test.po.User;
import io.swagger.annotations.Api;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@Api(value="用户信息")
@RestController
@RequestMapping("/user")
public class UserController {
@RequestMapping(value ="/info",method = RequestMethod.GET)
public String getUser(String userName){
return userName;
}
}
4.访问swagger页面
http://localhost:8089/swagger-ui.html# 端口号根据实际情况更改