接口管理工具的选择

前言

接口管理工具是面向前端的，也是前端与后台沟通的桥梁

做了小三年的Android开发，也是解除过很多的接口文档工具：

• word文档
• apizza
• postman
• rap
• 代码截图
• txt
• 口述
• 直接发代码文件
• swagger
  ... ...

但是觉得还是swagger比较方便，主要是不用再去写一份文档。

正文

好吧，不说废话了，那我们说下怎么配置吧：

添加依赖

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

配置类

与Application同级新建配置类：

配置类目录

@Configuration
@EnableSwagger2
public class SwaggerBuyer {


    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.ly.platform.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("平台 App接口管理后台")
                .contact("Ly")
                .version("1.0")
                .build();
    }
}

其中需要注意：

  .apis(RequestHandlerSelectors.basePackage("com.ly.platform.controller"))

这个配置为需要扫描的controller包路径，需要配置正确路径才可以进行扫描。

实际使用

@RestController
@RequestMapping("api/home")
@Api(value = "首页模块", description = "管理Banner")
public class BannerController {

    @Autowired
    private BannerService bannerService;

    @GetMapping("banner")
    @ApiOperation("查询所有的Banner")
    public List<Banner> getAllBanner() {
        return bannerService.findAll();
    }

}

关于注解的解释，可以移步官网进行查看，这边只用到了最常用的几个

使用效果

页面效果
在线请求
字段注释

结尾

没了...