Swagger使用指南
1：認識Swagger
Swagger 是一個規範和完整的框架，用於生成、描述、呼叫和視覺化 RESTful 風格的 Web 服務。總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。檔案的方法，引數和模型緊密整合到伺服器端的程式碼，允許API來始終保持同步。
作用：
1. 介面的文件線上自動生成。
2. 功能測試。
Swagger是一組開源專案，其中主要要專案如下：
1. Swagger-tools:提供各種與Swagger進行整合和互動的工具。例如模式檢驗、Swagger 1.2文件轉換成Swagger 2.0文件等功能。
2. Swagger-core: 用於Java/Scala的的Swagger實現。與JAX-RS(Jersey、Resteasy、CXF...)、Servlets和Play框架進行整合。
3. Swagger-js
4. Swagger-node-express: Swagger模組，用於node.js的Express web應用框架。
5. Swagger-ui：一個無依賴的HTML、JS和CSS集合，可以為Swagger相容API動態生成優雅文件。
6. Swagger-codegen：一個模板驅動引擎，通過分析使用者Swagger資源宣告以各種語言生成客戶端程式碼。
2：Maven
版本號請根據實際情況自行更改。
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency>
3：建立Swagger2配置類
在Application.java同級建立Swagger2的配置類Swagger2
package com.swaggerTest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Swagger2配置
* 在與spring boot整合時，放在與Application.java同級的目錄下。
* 通過@Configuration註解，讓Spring來載入該類配置。
* 再通過@EnableSwagger2註解來啟用Swagger2。
*/
@Configuration
@EnableSwagger2
public class Swagger2 {
/**
* 建立API應用
* apiInfo() 增加API相關資訊
* 通過select()函式返回一個ApiSelectorBuilder例項,用來控制哪些介面暴露給Swagger來展現，
* 本例採用指定掃描的包路徑來定義指定要建立API的目錄。
*
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.swaggerTest.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 建立該API的基本資訊（這些基本資訊會展現在文件頁面中）
* 訪問地址：http://專案實際地址/swagger-ui.html
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2構建RESTful APIs")
.description("更多請關注http://www.baidu.com")
.termsOfServiceUrl("http://www.baidu.com")
.contact("sunf")
.version("1.0")
.build();
}
}如上程式碼所示，通過createRestApi函式建立Docket的Bean之後，apiInfo()用來建立該Api的基本資訊（這些基本資訊會展現在文件頁面中）。
4：新增文件內容
在完成了上述配置後，其實已經可以生產文件內容，但是這樣的文件主要針對請求本身，描述的主要來源是函式的命名，對使用者並不友好，我們通常需要自己增加一些說明來豐富文件內容。
Swagger使用的註解及其說明：
@Api：用在類上，說明該類的作用。
@ApiOperation：註解來給API增加方法說明。
@ApiImplicitParams : 用在方法上包含一組引數說明。
@ApiImplicitParam：用來註解來給方法入參增加說明。
@ApiResponses：用於表示一組響應
@ApiResponse：用在@ApiResponses中，一般用於表達一個錯誤的響應資訊
l code：數字，例如400
l message：資訊，例如"請求引數沒填好"
l response：丟擲異常的類
@ApiModel：描述一個Model的資訊（一般用在請求引數無法使用@ApiImplicitParam註解進行描述的時候）
l @ApiModelProperty：描述一個model的屬性
注意：@ApiImplicitParam的引數說明：
| paramType：指定引數放在哪個地方 |
header：請求引數放置於Request Header，使用@RequestHeader獲取 query：請求引數放置於請求地址，使用@RequestParam獲取 path：（用於restful介面）-->請求引數的獲取：@PathVariable body：（不常用） form（不常用） |
| name：引數名 |
|
| dataType：引數型別 |
|
| required：引數是否必須傳 |
true | false |
| value：說明引數的意思 |
|
| defaultValue：引數的預設值 |
|
例子：
package com.swaggerTest.controller;
import org.springframework.stereotype.Controller;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
/**
* 一個用來測試swagger註解的控制器
* 注意@ApiImplicitParam的使用會影響程式執行，如果使用不當可能造成控制器收不到訊息
*
* @author SUNF
*/
@Controller
@RequestMapping("/say")
@Api(value = "SayController|一個用來測試swagger註解的控制器")
public class SayController {
@ResponseBody
@RequestMapping(value ="/getUserName", method= RequestMethod.GET)
@ApiOperation(value="根據使用者編號獲取使用者姓名", notes="test: 僅1和2有正確返回")
@ApiImplicitParam(paramType="query", name = "userNumber", value = "使用者編號", required = true, dataType = "Integer")
public String getUserName(@RequestParam Integer userNumber){
if(userNumber == 1){
return "張三丰";
}
else if(userNumber == 2){
return "慕容復";
}
else{
return "未知";
}
}
@ResponseBody
@RequestMapping("/updatePassword")
@ApiOperation(value="修改使用者密碼", notes="根據使用者id修改密碼")
@ApiImplicitParams({
@ApiImplicitParam(paramType="query", name = "userId", value = "使用者ID", required = true, dataType = "Integer"),
@ApiImplicitParam(paramType="query", name = "password", value = "舊密碼", required = true, dataType = "String"),
@ApiImplicitParam(paramType="query", name = "newPassword", value = "新密碼", required = true, dataType = "String")
})
public String updatePassword(@RequestParam(value="userId") Integer userId, @RequestParam(value="password") String password,
@RequestParam(value="newPassword") String newPassword){
if(userId <= 0 || userId > 2){
return "未知的使用者";
}
if(StringUtils.isEmpty(password) || StringUtils.isEmpty(newPassword)){
return "密碼不能為空";
}
if(password.equals(newPassword)){
return "新舊密碼不能相同";
}
return "密碼修改成功!";
}
}完成上述程式碼新增上，啟動Spring Boot程式，訪問：http://localhost:8080/swagger-ui.html
如上圖，可以看到暴漏出來的控制器資訊，點選進入可以看到詳細資訊。
兩個注意點：
1. paramType會直接影響程式的執行期，如果paramType與方法引數獲取使用的註解不一致，會直接影響到引數的接收。
例如：
使用Sawgger UI進行測試，接收不到！
2. 還有一個需要注意的地方：
Conntroller中定義的方法必須在@RequestMapper中顯示的指定RequestMethod型別，否則SawggerUi會預設為全型別皆可訪問， API列表中會生成多條專案。
如上圖：updatePassword()未指定requestMethod，結果生成了7條API資訊。所以如果沒有特殊需求，建議根據實際情況加上requestMethod。
5：Swagger UI面板說明
6：參考
http://blog.didispace.com/springbootswagger2/
http://blog.csdn.net/jia20003/article/details/50700736
Swagger官網 ：http://swagger.io/
Spring Boot & Swagger UI ： http://fruzenshtein.com/spring-boot-swagger-ui/
Github：https://github.com/swagger-api/swagger-core/wiki/Annotations
---------------------------------------------------------------------------------------
7：接收物件傳參的例子
在POJO上增加
-
package com.zhongying.api.model.base; -
import io.swagger.annotations.ApiModel; -
import io.swagger.annotations.ApiModelProperty; -
/** -
* 醫生物件模型，不要使用該類 -
* @author SUNF -
* -
*/ -
@ApiModel(value="醫生物件模型") -
public class DemoDoctor{ -
@ApiModelProperty(value="id" ,required=true) -
private Integer id; -
@ApiModelProperty(value="醫生姓名" ,required=true) -
private String name; -
public Integer getId() { -
return id; -
} -
public void setId(Integer id) { -
this.id = id; -
} -
public String getName() { -
return name; -
} -
public void setName(String name) { -
this.name = name; -
} -
@Override -
public String toString() { -
return "DemoDoctor [id=" + id + ", name=" + name + "]"; -
} -
}
注意： 在後臺採用物件接收引數時，Swagger自帶的工具採用的是JSON傳參， 測試時需要在引數上加入@RequestBody,正常執行採用form或URL提交時候請刪除。
-
package com.zhongying.api.controller.app; -
import java.util.ArrayList; -
import java.util.List; -
import javax.servlet.http.HttpServletRequest; -
import org.springframework.stereotype.Controller; -
import org.springframework.web.bind.annotation.RequestBody; -
import org.springframework.web.bind.annotation.RequestMapping; -
import org.springframework.web.bind.annotation.RequestMethod; -
import org.springframework.web.bind.annotation.RequestParam; -
import org.springframework.web.bind.annotation.ResponseBody; -
import com.github.pagehelper.PageInfo; -
import com.zhongying.api.exception.HttpStatus401Exception; -
import com.zhongying.api.model.base.DemoDoctor; -
import io.swagger.annotations.Api; -
import io.swagger.annotations.ApiImplicitParam; -
import io.swagger.annotations.ApiImplicitParams; -
import io.swagger.annotations.ApiOperation; -
/** -
* 醫生類（模擬） -
* @author SUNF -
*/ -
@RequestMapping("/api/v1") -
@Controller -
@Api(value = "DoctorTestController-醫生資訊介面模擬") -
public class DoctorTestController { -
/** -
* 新增醫生 -
* -
* 在使用物件封裝引數進行傳參時，需要在該物件添加註解，將其註冊到swagger中 -
* @link com.zhongying.api.model.base.DemoDoctor -
* -
* 注意： 在後臺採用物件接收引數時，Swagger自帶的工具採用的是JSON傳參， -
* 測試時需要在引數上加入@RequestBody,正常執行採用form或URL提交時候請刪除。 -
* -
* @param doctor 醫生類物件 -
* @return -
* @throws Exception -
*/ -
@ResponseBody -
@RequestMapping(value="/doctor", method= RequestMethod.POST ) -
@ApiOperation(value="新增醫生資訊", notes="") -
public String addDoctor(@RequestBody DemoDoctor doctor) throws Exception{ -
if(null == doctor || doctor.getId() == null){ -
throw new HttpStatus401Exception("新增醫生失敗","DT3388","未知原因","請聯絡管理員"); -
} -
try { -
System.out.println("成功----------->"+doctor.getName()); -
} catch (Exception e) { -
throw new HttpStatus401Exception("新增醫生失敗","DT3388","未知原因","請聯絡管理員"); -
} -
return doctor.getId().toString(); -
} -
/** -
* 刪除醫生 -
* @param doctorId 醫生ID -
* @return -
*/ -
@ResponseBody -
@RequestMapping(value="/doctor/{doctorId}", method= RequestMethod.DELETE ) -
@ApiOperation(value="刪除醫生資訊", notes="") -
@ApiImplicitParam(paramType="query", name = "doctorId", value = "醫生ID", required = true, dataType = "Integer") -
public String deleteDoctor(@RequestParam Integer doctorId){ -
if(doctorId > 2){ -
return "刪除失敗"; -
} -
return "刪除成功"; -
} -
/** -
* 修改醫生資訊 -
* @param doctorId 醫生ID -
* @param doctor 醫生資訊 -
* @return -
* @throws HttpStatus401Exception -
*/ -
@ResponseBody -
@RequestMapping(value="/doctor/{doctorId}", method= RequestMethod.POST ) -
@ApiOperation(value="修改醫生資訊", notes="") -
@ApiImplicitParam(paramType="query", name = "doctorId", value = "醫生ID", required = true, dataType = "Integer") -
public String updateDoctor(@RequestParam Integer doctorId, @RequestBody DemoDoctor doctor) throws HttpStatus401Exception{ -
if(null == doctorId || null == doctor){ -
throw new HttpStatus401Exception("修改醫生資訊失敗","DT3391","id不能為空","請修改"); -
} -
if(doctorId > 5 ){ -
throw new HttpStatus401Exception("醫生不存在","DT3392","錯誤的ID","請更換ID"); -
} -
System.out.println(doctorId); -
System.out.println(doctor); -
return "修改成功"; -
} -
/** -
* 獲取醫生詳細資訊 -
* @param doctorId 醫生ID -
* @return -
* @throws HttpStatus401Exception -
*/ -
@ResponseBody -
@RequestMapping(value="/doctor/{doctorId}", method= RequestMethod.GET ) -
@ApiOperation(value="獲取醫生詳細資訊", notes="僅返回姓名..") -
@ApiImplicitParam(paramType="query", name = "doctorId", value = "醫生ID", required = true, dataType = "Integer") -
public DemoDoctor getDoctorDetail(@RequestParam Integer doctorId) throws HttpStatus401Exception{ -
System.out.println(doctorId); -
if(null == doctorId){ -
throw new HttpStatus401Exception("檢視醫生資訊失敗","DT3390","未知原因","請聯絡管理員"); -
} -
if(doctorId > 3){ -
throw new HttpStatus401Exception("醫生不存在","DT3392","錯誤的ID","請更換ID"); -
} -
DemoDoctor doctor = new DemoDoctor(); -
doctor.setId(1); -
doctor.setName("測試員"); -
return doctor; -
} -
/** -
* 獲取醫生列表 -
* @param pageIndex 當前頁數 -
* @param pageSize 每頁記錄數 -
* @param request -
* @return -
* @throws HttpStatus401Exception -
*/ -
@ResponseBody -
@RequestMapping(value="/doctor", method= RequestMethod.GET ) -
@ApiOperation(value="獲取醫生列表", notes="目前一次全部取，不分頁") -
@ApiImplicitParams({ -
@ApiImplicitParam(paramType="header", name = "token", value = "token", required = true, dataType = "String"), -
@ApiImplicitParam(paramType="query", name = "pageIndex", value = "當前頁數", required = false, dataType = "String"), -
@ApiImplicitParam(paramType="query", name = "pageSize", value = "每頁記錄數", required = true, dataType = "String"), -
}) -
public PageInfo<DemoDoctor> getDoctorList(@RequestParam(value = "pageIndex", required = false, defaultValue = "1") Integer pageIndex, -
@RequestParam(value = "pageSize", required = false) Integer pageSize, -
HttpServletRequest request) throws HttpStatus401Exception{ -
String token = request.getHeader("token"); -
if(null == token){ -
throw new HttpStatus401Exception("沒有許可權","SS8888","沒有許可權","請檢視操作文件"); -
} -
if(null == pageSize){ -
throw new HttpStatus401Exception("每頁記錄數不粗安在","DT3399","不存在pageSize","請檢視操作文件"); -
} -
DemoDoctor doctor1 = new DemoDoctor(); -
doctor1.setId(1); -
doctor1.setName("測試員1"); -
DemoDoctor doctor2 = new DemoDoctor(); -
doctor2.setId(2); -
doctor2.setName("測試員2"); -
List<DemoDoctor> doctorList = new ArrayList<DemoDoctor>(); -
doctorList.add(doctor1); -
doctorList.add(doctor2); -
return new PageInfo<DemoDoctor>(doctorList); -
} -
}
增加header:
現在很多請求需要在header增加額外引數，可以參考getDoctorList()的做法，