Java Tech

如无必要,勿增实体

标签 "接口文档" 下的文章

Restful形式接口文档生成之Swagger与SpringMVC整合手记

  笔者目前正在搭建一套API服务框架,考虑到客户端能够更方便的调用API服务(这里说的更方便是指避免不厌其烦地解说各接口需要的参数和返回结果),于是决心为每个接口生成详细的说明文档。网上搜索了一下,发现了Swagger这个东西,感觉不错,界面也比javadoc生成的页面要美观,而且网上关于Swagger和springmvc整合的文章不少(遗憾的是大多雷同且不完整)。本文详细介绍Swagger和SpringMVC的整合过程,重点是弥补现有文章的遗漏之处(很关键的哦!)。让我们一起来学习如何使用Swagger来生成接口文档吧!