swager2的簡介

在App后端開發中經常需要對移動客戶端（Android、iOS）提供RESTful API接口，在后期版本快速迭代的過程中，修改接口實現的時候都必須同步修改接口文檔，而文檔與代碼又處于兩個不同的媒介，除非有嚴格的管理機制，不然很容易導致代碼與接口文檔不一致現象。

RESTful API的重磅好伙伴Swagger2，它可以輕松的整合到Spring生態鏈中，并與Spring MVC程序配合組織出強大RESTful API文檔。它既可以減少我們創建文檔的工作量，同時又將說明內容整合入實現代碼中，讓維護文檔和修改代碼整合為一體，方便讓我們在修改代碼邏輯的同時方便的修改文檔說明。另外Swagger2也提供了強大的頁面測試功能來調試每個RESTful API

添加Swagger2依賴

在pom.xml中加入Swagger2的依賴，目前引用的是最新的release版本：2.7.0

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.7.0</version>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.7.0</version>

</dependency>

Swagger2配置類

其中有幾個參數需要說明一下：

SWAGGER_SCAN_BASE_PACKAGE:所在微服務的web目錄

ApiInfo主要是微服務的一些系統級別的配置

參數	說明
title	微服務標題
description	微服務的描述信息
license	許可證（按照這個配置即可）
version	微服務版本號
contract	微服務開發者聯系方式，配置完成后，如有問題，可以給微服務開發人員發送郵件

Docket是創建swagger的配置信息（可以進行分組，目前沒有添加）

關于這塊內容，大家可以參考這篇文章：

http://blog.csdn.net/top_code/article/details/54023136

controller的編寫

swagger在yml中的配置：

打包Spring Boot程序并啟動，打開瀏覽器訪問：http://localhost:8080/swagger-ui.html，就能看到前文所展示的RESTful API的頁面。

總結

以上是生活随笔為你收集整理的Swagger服务API治理详解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。