Spring boot+Swagger2

1 引入swagger的依赖

例如如下版本

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>

2。编写配置文件（重点：可照抄如下代码，只需要变动自己要扫描的controller位置）

package com.souche.salt_common_01.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.souche.salt_common_01.controller")) //重点在这里。不能照抄 ，要指定自己的包名
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot利用swagger构建api文档")
.description("简单优雅的restfun风格，http://blog.csdn.net/saytime")
.termsOfServiceUrl("http://blog.csdn.net/saytime")
.version("1.0")
.build();
}
}

3 在启动类上（springboot 启动的那个application类）加注解
@EnableSwagger2

如

package com.example.testSwagger;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class TestSwaggerApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestSwaggerApplication.class, args);
    }

}

4 完成以上步骤已经可以测试一下是否成功
首先启动的项目，然后访问http://项目地址/swagger-ui.html

例如我的 http://localhost:8080/swagger-ui.html
打开这个页面如果能看到controller层的接口则表示成功

如果你项目中还没有写接口则此页面没有接口展示例如没有 /test

3 编写controller层

3.1 在在类头上写@Api(description = "快速执行，作业执行",tags = "salt执行接口")
tags表示对接口分组：如两个contronller层的tags相同则这两个页面的接口在同一个分组里

3.2 在方法头上写 @ApiOperation(value = "快速执行脚本") 描述本方法的作用

3.3 指定请求类型，和请求路径@GetMapping("/lantu/client/script/fast")

效果如下

package com.example.testSwagger.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(description = "这是测试",tags = "test")
public class TestController {

@GetMapping("/test")
@ApiOperation("执行一个方法")
public void test(){
System.err.println("hello world");
}

}

效果如下

猜你喜欢