可以在项目中创建SwaggerConfig，进行配置文档内容
1、配置基本信息
Docket:摘要对象，通过对象配置描述文件的信息。
apiInfo:设置描述文件中info。参数类型ApiInfo
select():返回ApiSelectorBuilder对象，通过对象调用build()可以创建Docket对象。
ApiInfoBuilder: ApiInfo 构建器。
public class SwaggerConfig {
@Bean
public Docket getDocket() {
return new Docket(DocumentationType_SWAGGER_2)
.apiInfo(swaggerDemoApiInfo())
.select()
.build();
}
public ApiInfo swaggerDemoApiInfo(){
return new ApiInfoBuilder()
.contact(new Contact("五道口职业技术学院", "http://wdk.com","[email protected]"))
//文档标题
.title("这里是Swagger的标题")
//文档描述
.description("这里是Swagger的描述")
//文档版本
.version("1.0.0")
.build();
}
}
2、如何让SwaggerConfig 区分文档
@Api(tags = {"MyController"}, description = "用户登录控制器")
public class MyController {
//登陆操作
@PostMapping("/login")
public boolean login(String uname, String pwd){
return true;
}
@PostMapping("/save")
public boolean save(String uname, String pwd) {
}
}
@Api(tags = {"MyController"}, description = "用户访问控制器")public class MyController2 {
//登陆操作
@PostMapping("/login")
public boolean login(String uname, String pwd){
return true;
}
@PostMapping("/save")
public boolean save(String uname, String pwd) {
}
}
2、ApiOperation@ApiOperation 写在方法上，对方法进行总体描述
● value: 接口描述
● notes: 提示信息
代码示例：
@ApiOperation(value = "接口描述", notes="接口提示信息")
ApiParam@Apiparam 写在方法参数前面。 用于对参数进行描述或说明是否为必添项等说明。
● name： 参数名称
● value： 参数描述
● required： 是否是必须
public People getPeople(Integer id, @ApiParam(value="姓名", required = true) String name, String address)