引入swagger依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
启动类增加包扫描
@SpringBootApplication(scanBasePackages = “com.xmlly.deploy”)
增加Swagger配置SwaggerConfig
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket swaggerSpringMvcPlugin() {
return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
} }
接口文档
在controller类上面增加注解@Api(“Deploy测试”)
@RequestMapping指定请求类型GET/POST
@ApiOperation((value=“接口地址”)一般和方法名一致
@ApiOperation(value = “test”, notes = “接口测试notes”)
@ApiImplicitParams({
@ApiImplicitParam(name = “name”, value = “名称”, required = true, paramType = “query”)
})
@RequestMapping(value = “/test”,method = RequestMethod.GET)
public String test(String name) {
return name + “,hhhhhhh”;
}
启动服务访问页面http://ip:端口号/swagger-ui.html