一直以来做对外的接口文档都比较原始&＃xff0c;基本上都是手写的文档传来传去&＃xff0c;最近发现了一个新玩具&＃xff0c;可以在接口上省去不少麻烦。
swagger是一款方便展示的API文档框架。它可以将接口的类型最全面的展示给对方开发人员&＃xff0c;避免了手写文档的片面和误差行为。
swagger目前有两种swagger和swagger2两种&＃xff0c;1比较麻烦&＃xff0c;所以不考虑使用。本文主要记录我用swagger2做对外接口的两种方式&＃xff0c;方面后面查阅。
一、使用传统的springmvc整合swagger2
1、maven依赖
com.fasterxml.jackson.core
jackson-core
2.8.0
com.fasterxml.jackson.core
jackson-databind
2.6.3
com.fasterxml.jackson.core
jackson-annotations
2.6.3
io.springfox
springfox-swagger2
2.4.0
io.springfox
springfox-swagger-ui
2.4.0
2、spring-mvc.xml 中添加映射静态的配置(其实我项目中把这个去掉也可以&＃xff0c;不知道什么情况)&＃xff1a;
注意&＃xff1a;基本的springmvc配置我就不贴了&＃xff0c;需要注意的是&＃xff0c;如果你看到swagger-ui.html 界面出来&＃xff0c;但却一片空白&＃xff0c;请检查下你web.xml中拦截器的配置&＃xff0c;一定要springmvc先拦截到&＃xff0c;然后界面才会显示的。
3、然后是swagger2的配置类&＃xff1a;
&＃64;Configuration
&＃64;EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {
&＃64;Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("net.laoyeyey.yyblog"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("yyblog项目 RESTful APIs")
.description("yyblog项目api接口文档")
.version("1.0")
.build();
}
}
注意&＃xff1a;paths如果在生产情况下可以调整为PathSelectors.none()&＃xff0c;即不显示所有接口信息&＃xff1b;
4、接口信息配置
即在SpringMvc的Controller中配置相关的接口信息
&＃64;Controller
&＃64;RequestMapping(value &＃61; "aitou")
&＃64;Api(description &＃61; "测试服务-账户信息查询")
public class DailyOperationDataController {
Logger logger &＃61; Logger.getLogger(DailyOperationDataController.class);
&＃64;Autowired
private DailyOperationDataService DailyOperationDataService;
/*
* &＃64;ApiOperation(value &＃61; "接口说明", httpMethod &＃61;"接口请求方式", response &＃61;"接口返回参数类型", notes &＃61;"接口发布说明"
* &＃64;ApiParam(required &＃61; "是否必须参数", name &＃61;"参数名称", value &＃61;"参数具体描述"
*/
&＃64;ApiOperation(value &＃61; "账户信息查询接口")
&＃64;RequestMapping(method &＃61;{RequestMethod.POST,RequestMethod.GET}, value&＃61;"/query/dailydata/{dataDate}")
&＃64;ResponseBody
public DailyOperationDataDto getDailyReportByDataDate(&＃64;PathVariable("dataDate") String dataDate) {
try {
return DailyOperationDataService.getDailyReportByDataDate(dataDate);
} catch (Exception e) {
logger.error(e.getMessage(), e);
}
return null;
}
}
注&＃xff1a;通常情况下swagger2会将扫描包下所有的接口展示出来&＃xff0c;这里我是对外的接口是单独一个包&＃xff0c;避免展示过多的接口&＃xff0c;当然接口方法也可以让它不展示。可以在下面看到相关的注解中有写。
常用的一些注解
&＃64;Api&＃xff1a;用在类上&＃xff0c;说明该类的作用
&＃64;ApiOperation&＃xff1a;用在方法上&＃xff0c;说明方法的作用
&＃64;ApiImplicitParams&＃xff1a;用在方法上包含一组参数说明
&＃64;ApiImplicitParam&＃xff1a;用在 &＃64;ApiImplicitParams 注解中&＃xff0c;指定一个请求参数的各个方面
paramType&＃xff1a;参数放在哪个地方
· header --> 请求参数的获取&＃xff1a;&＃64;RequestHeader
· query -->请求参数的获取&＃xff1a;&＃64;RequestParam
· path(用于restful接口)--> 请求参数的获取&＃xff1a;&＃64;PathVariable
· body(不常用)
· form(不常用)
name&＃xff1a;参数名
dataType&＃xff1a;参数类型
required&＃xff1a;参数是否必须传
value&＃xff1a;参数的意思
defaultValue&＃xff1a;参数的默认值
&＃64;ApiResponses&＃xff1a;用于表示一组响应
&＃64;ApiResponse&＃xff1a;用在&＃64;ApiResponses中&＃xff0c;一般用于表达一个错误的响应信息
code&＃xff1a;数字&＃xff0c;例如400
message&＃xff1a;信息&＃xff0c;例如"请求参数没填好"
response&＃xff1a;抛出异常的类
&＃64;ApiParam&＃xff1a;单个参数描述
&＃64;ApiModel&＃xff1a;描述一个Model的信息&＃xff0c;用对象来接收参数(这种一般用在post创建的时候&＃xff0c;使用&＃64;RequestBody这样的场景&＃xff0c;请求参数无法使用&＃64;ApiImplicitParam注解进行描述的时候)
&＃64;ApiModelProperty&＃xff1a;描述一个model的属性
&＃64;ApiProperty&＃xff1a;用对象接收参数时&＃xff0c;描述对象的一个字段
&＃64;ApiIgnore&＃xff1a;使用该注解忽略这个API
基本上就是上面这些了&＃xff0c;是不是很easy&＃xff0c;下面看下效果图
![]()
![]()
二、使用springboot整合swagger2
上面说了使用传统的springmvc整合swagger2&＃xff0c;在说说最近比较流行的springboot的方式&＃xff0c;其实原理都是一样的。
1、maven依赖
io.springfox
springfox-swagger2
2.7.0
io.springfox
springfox-swagger-ui
2.7.0
这个是我最近用springboot写的个人项目中的内用&＃xff0c;版本用的2.7.0
2、添加静态资源配置
&＃64;Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {/**
* 配置静态资源路径以及上传文件的路径
*
* &＃64;param registry
*/
&＃64;Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
registry.addResourceHandler("/upload/**").addResourceLocations(environment.getProperty("spring.resources.static-locations"));
/*swagger-ui*/
registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
其实就是最后两句&＃xff0c;如果你不配置这个的话&＃xff0c;访问swagger-ui.html会出现500&＃xff0c;还是404的错误来着&＃xff0c;记不清了&＃xff0c;应该是404.
3、swagger2的配置类
和上面一样&＃xff0c;基本上没区别
&＃64;Configuration
&＃64;EnableSwagger2
&＃64;EnableWebMvc
public class SwaggerConfig extends WebMvcConfigurationSupport {
&＃64;Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("net.laoyeye.yyblog.web.frontend"))
.paths(PathSelectors.none())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("yyblog项目 RESTful APIs")
.description("yyblog项目api接口文档")
.version("1.0")
.build();
}
}
注意&＃xff0c;我上面有说path的问题哦&＃xff0c;直接拷贝不显示api的&＃xff0c;(#^.^#)
4、接口的配置
/**
* 前台文章Controller
* &＃64;author 小卖铺的老爷爷
* &＃64;date 2018年5月5日
* &＃64;website www.laoyeye.net
*/
&＃64;Api(description&＃61;"文章查询")
&＃64;Controller
&＃64;RequestMapping("/article")
public class ArticleController {
&＃64;Autowired
private ArticleService articleService;
&＃64;Autowired
private SettingService settingService;
&＃64;Autowired
private CateService cateService;
&＃64;Autowired
private TagReferService tagReferService;
&＃64;Autowired
private UserService userService;
&＃64;Autowired
private ArticleMapper articleMapper;
&＃64;Autowired
private CommentService commentService;
&＃64;ApiOperation(value&＃61;"文章查询接口")
&＃64;ApiImplicitParam(name &＃61; "id", value &＃61; "文章ID", required &＃61; true, dataType &＃61; "Long")
&＃64;GetMapping("/{id}")
public String index(Model model, &＃64;PathVariable("id") Long id) {
try {
articleService.updateViewsById(id);
} catch (Exception ignore) {
}
List settings &＃61; settingService.listAll();
Map map &＃61; new HashMap();
for (Setting setting : settings) {
map.put(setting.getCode(), setting.getValue());
}
Article article &＃61; articleService.getArticleById(id);
model.addAttribute("settings", map);
model.addAttribute("cateList", cateService.listAllCate());
model.addAttribute("article", article);
model.addAttribute("tags", tagReferService.listNameByArticleId(article.getId()));
model.addAttribute("author", userService.getNicknameById(article.getAuthorId()));
//回头改
model.addAttribute("articles", articleMapper.listArticleByTitle(null));
model.addAttribute("similars", articleMapper.listArticleByTitle(null));
CommentQuery query &＃61; new CommentQuery();
query.setLimit(10);
query.setPage(1);
query.setArticleId(id);
model.addAttribute("comments", commentService.listCommentByArticleId(query));
return "frontend/article";
}
&＃64;ApiOperation(value&＃61;"文章评论查询接口")
&＃64;PostMapping("/comments")
&＃64;ResponseBody
public DataGridResult comments(CommentQuery query) {
//设置默认10
query.setLimit(10);
return commentService.listCommentByArticleId(query);
}
&＃64;ApiOperation(value&＃61;"文章点赞接口")
&＃64;ApiImplicitParam(name &＃61; "articleId", value &＃61; "文章ID", required &＃61; true, dataType &＃61; "Long")
&＃64;PostMapping("/approve")
&＃64;ResponseBody
public YYBlogResult approve(&＃64;RequestParam Long articleId) {
return articleService.updateApproveCntById(articleId);
}
}
最后同样来个效果图&＃xff0c;和上面一样。
PathSelectors.none()的时候
![]()
PathSelectors.any()的时候
![]()
![]()
看到效果图是不是接口内容一目了然&＃xff0c;很简洁明了了。
最后&＃xff0c;好像忘记说swagger文档的路径了
如果你的项目在根目录&＃xff1a;http://localhost:8080/swagger-ui.html
如果不是根目录那就是&＃xff1a;http://localhost:8080/你的项目名/swagger-ui.html
以上就是本文的全部内容&＃xff0c;希望对大家的学习有所帮助&＃xff0c;也希望大家多多支持我们。
本文标题: Java利用Swagger2自动生成对外接口的文档
本文地址: http://www.cppcns.com/ruanjian/java/231096.html
京公网安备 11010802041100号