api文档自动生成 -swagger ui

swagger ui

@Bean
public Docket testApi(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("v0.0.1")
.genericModelSubstitutes(DeferredResult.class)
.useDefaultResponseMessages(false)
.forCodeGeneration(true)
.pathMapping("/test")
.select()
.paths(PathSelectors.regex("/common/.*"))
.build()
.apiInfo(testApiInfo());
}

docket （摘要） 文档类型我们使用了SWAGGER_2这个
groupName 每一个组的名称，

genericModelSubstitutes (通用模型替换)
deferredResult 延期结果
提供了异步的请求进程
useDefaultResponseMessages（使用默认的响应信息）
true：默认的信息信息将会加到全局的响应信息中
false：默认的响应信息不会加到全局的响应信息中
forCodeGeneration（自动生成代码）
pathMapping（路径匹配）
如果默认为基础的api基本路径

select () 启动api选择构建者  （将创建一个新的构建者）
paths
PathSelectors
regex 通过正则表达式匹配url路径
apiInfo（）将api描述信息录入

private ApiInfo testApiInfo(){
Contact contact=new Contact();
contact.setName("赵睿");
ApiInfo apiInfo=new ApiInfo("标题", "描述", "v0.0.1", "服务条款链接", contact.getName(), "许可证", "许可证链接");
return apiInfo;
}

/**
* 简单接口描述
*
* @param userName
* @return
*/
@RequestMapping(value = "/demo1", method = RequestMethod.POST)
@ApiOperation(value = "测试接口1", notes = "简单接口描述 userName必填", code = 200, produces = "application/json")
public ModelMap getDemo(@RequestParam("userName") String userName) {
ModelMap map = new ModelMap();
map.addAttribute("userName", userName);
return map;
}