SpringBoot介入Swagger 2.0完善 生成接口文档生成，接口测试 SwaggerFox模式的

1. 搭建Swawgger2环境(添加依赖）

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

2. 配置类

@Configuration//创建配置类的注解
@EnableSwagger2//打开支持Swagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.pathMapping("/")//访问的路径
.select()
.apis(RequestHandlerSelectors.basePackage("com.example"))//扫描注解包所在的位置
.paths(PathSelectors.any())
.build().apiInfo(new ApiInfoBuilder()
.title("智慧景区公共信息云平台后台服务接口列表")//接口大标题
.description("服务中心,运营中心等相关接口说明...")//接口说明
.version("2.1")//版本号
.contact(new Contact("大老板","blog.csdn.net","aaa@gmail.com"))
.license("China dci")
.licenseUrl("http://www.chinadci.com")
.build());
}
}

3. 接口中的

@RestController
@Api(tags = "学生的接口")//接口类的说明
public class StudentController {
@ApiOperation(value = "查询学生的信息")//接口说明
@GetMapping("SelectStudent")
public Object SelectStudent(){
return "查询学生..............";
}
@PostMapping("InsertStudent")
@ApiOperation(value = "添加学生")//接口说明
@ApiImplicitParams(//接口参数说明
{
@ApiImplicitParam(name = "name", value = "学生名字"),
@ApiImplicitParam(name = "pwd", value = "学生密码")
}
)
public Object InsertStudent(String name,String pwd){
return "添加学生..............";
}
}

4. 实体类

@Setter
@Getter
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "学生的Model")//实体类的说明
public class Student {
@ApiModelProperty(value = "学生id")//字段说明
private Integer id;
@ApiModelProperty(value = "学生姓名")//字段说明
private String name;
@ApiModelProperty(value = "学生密码")//字段说明
private String pwd;
}

5. 启动后 访问 http://localhost:8080/swagger-ui.html

代码中遇到问题

swagger-ui Models不显示

解决办法：@RequestBody

@ApiOperation(value = “申请提交”)
public String save(@RequestBody LargeCostDO largeCostDO)
必须加上@RequestBody注解。
只要加上@RequestBody注解，就算实体类上不加@ApiModel也会显示的。

@RequestBody是将request的body序列化成Java对象，
@RequestBody注解不写也可以序列化。
但是swagger就是根据这个@RequestBody判断的。

最后

以上就是过时咖啡为你收集整理的SpringBoot介入Swagger 2.0完善 生成接口文档生成，接口测试 SwaggerFox模式的SpringBoot介入Swagger 2.0完善 生成接口文档生成，接口测试 SwaggerFox模式的代码中遇到问题的全部内容，希望文章能够帮你解决SpringBoot介入Swagger 2.0完善 生成接口文档生成，接口测试 SwaggerFox模式的SpringBoot介入Swagger 2.0完善 生成接口文档生成，接口测试 SwaggerFox模式的代码中遇到问题所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。