李桃峰的技术博客

# Swagger的使用

Swagger是一个根据Swagger注解，即可生成接口文档的服务。

# 导航

回到spring cloud alibaba导航页 回到主导航页

# pom.xml

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-common</artifactId>
            <version>2.9.2</version>
        </dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.List;

import static com.google.common.collect.Lists.newArrayList;

/**
 * @ClassName：SwaggerConfig
 * @Description：
 * @author: Torey
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //加了ApiOperation注解的类，才生成接口文档
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                //包下的类，才生成接口文档
                //.apis(RequestHandlerSelectors.basePackage("com.xxxx.xxxx.controller"))
                .paths(PathSelectors.any())
                .build()
                .directModelSubstitute(java.util.Date.class, String.class);
                //.securitySchemes(security());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("标题")
                .description("描述")
                .termsOfServiceUrl("http://www.baidu.com/")
                .version("2.0")
                .build();
    }

//    private List<ApiKey> security() {
//        return newArrayList(
//                new ApiKey("token", "token", "header")
//        );
//    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# Swagger常用注解

  • @Api注解用在类上，说明该类的作用。可以标记一个Controller类做为swagger文档资源
  • @ApiOperation注解用在方法上，说明该方法的作用
  • @ApiParam注解用在方法参数上
  • @ApiImplicitParams注解用在方法上，主要用于一组参数说明
  • @ApiIgnore注解，可用于类、方法或参数上，表示生成Swagger接口文档时，忽略类、方法或参数。
@Api("AAA")
@RestController
@RequestMapping("/shares")
public class ShareController {
    @Autowired
    private ShareService shareService;
    @ApiOperation("内容中心")
    @GetMapping("/{id}")
    public ShareDTO findById(@ApiParam(value = "内容中心id",required = true)
                                 @PathVariable Integer id){
       return shareService.findById(id);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
@ApiImplicitParams({ @ApiImplicitParam(name = "page", value = "当前页码，从1开始", paramType = "query", requ ired = true, dataType="int") , @ApiImplicitParam(name = "limit", value = "每页显示记录数", paramType = "query",requir ed = true, dataType="int") , @ApiImplicitParam(name = "order_field", value = "排序字段", paramType = "query", dataT ype="String") , @ApiImplicitParam(name = "order", value = "排序方式，可选值(asc、desc)", paramType = "q uery", dataType="String") , @ApiImplicitParam(name = "username", value = "用户名", paramType = "query", dataType=" String") })public Result<PageData<SysUserDTO>> page(@ApiIgnore @RequestParam Map<String, Object> par ams){ PageData<SysUserDTO> page = sysUserService.page(params); return new Result<PageData<SysUserDTO>>().ok(page); }
1

# 支持我-微信扫一扫-加入微信公众号

Aseven公众号

# 赞赏作者

赞赏作者