json格式 入参文档_swagger接口文档生成工具

文章首推

• 支付宝接口对接
• 高德地图调用
• 验证码登录
• QQ邮箱登录

今日主题:swagger接口文档生成工具

简介

在一个大的的项目中可能会有很多控制类，每个控制类中会有很多方法，这时候我们需要一个接口文档生成工具来暴露这些接口，方便我们进行直接查找测试，确实是方便了很多，那么来学习一下吧

环境

• springboot

实现过程

1、创建一个springboot项目工程,添加依赖

        io.springfoxspringfox-swagger-ui2.4.0        io.springfoxspringfox-swagger22.4.0

2、添加配置文件

//swagger2的配置文件，在项目的启动类的同级文件建立@Configuration@EnableSwagger2public class SwaggerConfig {    @Bean    public Docket api() {        return new Docket(DocumentationType.SWAGGER_2)                .select()  // 选择那些路径和api会生成document                .apis(RequestHandlerSelectors.any()) // 对所有api进行监控                .paths(PathSelectors.any()) // 对所有路径进行监控                .build();    }}

3、准备控制类

@PostMapping("/hello")    @ApiOperation(value = "测试",notes = "这是一个测试文档")    public String hello(){        return "hello";    }

4、启动项目，访问地址：http://localhost:端口//这里可以进行测试

Swagger全部是以JSON的格式向后台传参的

这是非常重要的一点，我自己找了很多文章才发现的，入参都是以json格式的，也就是说只支持@RequestBody的入参。

想下面这个就不行：

@GetMapping("/test")    public String test(String test){        return test;    }

大家可以看到响应体是no content其实这里也已经给我们答案了，参数类型只支持json格式

我录了一个视频，大家可以看看

---

欢迎关注：java后端指南

请给鹏哥点个在看吧