在Spring REST API中使用Swagger2进行文档管理

写在前面

使用RESTful API作为Web服务对外提供服务的入口,基本上已经成为了标准,在提供REST API的同时,如何进行
API文档管理是一个较为麻烦的事情,作为开发人员我们都了解API文档的重要性,但总是嫌其编写的麻烦,Swagger的
出现很好地帮我们解决文档编写的事情,开发人员可以采取自己喜欢的姿势进行API文档编写,例如使用Swagger-Editor
进行API的提前设计,进而使用Swagger-Codegen来生成多种语言的客户端代码,使用Swagger-UI来进行API文档
的直观查看,当然你也可以在代码中直接进行API文档的编写,本教程将介绍如何在Spring REST API项目中,进行
Swagger2的集成,这样便可以很方便地进行API文档编写了。

在本篇教程中将使用Springfox的Swagger实现来集成,关于 Swagger2 和 Springfox 的介绍如下:

项目配置

本教程将假设你已经有了一个Spring REST服务,如果没有话,可以参考Spring官方项目示例:

Building a RESTful Web Service

添加Maven依赖

在你的Spring REST项目中添加maven依赖,打开项目的pom.xml,添加如下内容:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>

在项目中集成Swagger2

集成Swagger2

首先创建一个SwaggerConfiguration类,如下:

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {                                    
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)  
          .select()                                  
          .apis(RequestHandlerSelectors.any())              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}

通过使用@EnableSwagger2注解来开启Swagger2,在整个类中最重要的便是Docket的Bean,Docket定义了
Swagger的版本、需要暴露的API等信息,我们来看看Docket生成后都做了些什么工作:

  1. 创建一个Docket对象
  2. 调用select()方法,生成ApiSelectorBuilder对象实例,该对象负责定义外漏的API入口
  3. 通过使用RequestHandlerSelectorsPathSelectors来提供Predicate,在此我们使用any()方法,将所有API都通过Swagger进行文档管理

如果你的项目是一个Spring Boot项目,上面的配置已经OK了,可以开始进行API文档的编写了,但如果你的项目
不是Spring Boot项目,只是Spring项目的话,需要稍微多做些工作。

非Spring Boot项目中,配置Resource Handler

由于没有使用Spring Boot,这样就不能自动配置Resource Handler,需要自己进行下配置,因为我们接下来要使用
Swagger UI,它有些静态资源需要加载,新建一个类,继承WebMvcConfigurerAdapter并使用@EnableWebMvc注解,然后添加如下代码,如果你已经有了一个这样的类,可以进行将以下代码添加至该类:

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("swagger-ui.html")
      .addResourceLocations("classpath:/META-INF/resources/");

    registry.addResourceHandler("/webjars/**")
      .addResourceLocations("classpath:/META-INF/resources/webjars/");
}

体验成果

假设我是使用Spring REST官方示例项目的话,打开浏览器,输入:

http://localhost:8080/v2/api-docs

你应该会看到JSON格式的API文档,如下图所示:

Swagger2 API Docs

这样的JSON文件,读起来是很不方便的,接下来我们用Swagger UI来进行查看。

Swagger UI

Swagger UI提供了Web页面以方便开发人员查看API文档等。

集成Swagger UI

在项目pom.xml中引入:

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
</dependency>

在此运行示例项目,在浏览器中输入:

http://localhost:8080/swagger-ui.html

可以看到如下Web页面:

Swagger UI

写在后面

到此你已经成功地在项目中集成了Swagger2,接下来可以使用Springfox的注解进行API文档编写了,详细阅读:

http://springfox.github.io/springfox/docs/current/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容