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: 用於JavaScript的Swagger實現。
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獲取 package com.swaggerTest.controller;
完成上述代碼添加上，啟動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()的做法，使用request接收 原文地址：https://blog.csdn.net/xiaoxinxin123456789/article/details/83994859 |
