Swagger與postman使用心得

時間 2019-12-18

標籤 swagger postman 使用心得简体版

原文原文鏈接

Swagger接口文檔，在線自動生成模板和頁面。服務器地址加上swagger-ui.html後綴便可訪問到（https://域名:端口號/swagger-ui.html）。

使用時在java代碼中引用navan管理pom.xml中添加依賴：

  
  
  
  
   
 
    
     
      
     
     
      
      <!-- Swagger-mvc --> 
      
     
 
    
     
      
     
     
      
      <dependency> 
      
     
 
    
     
      
     
     
      
      <groupId>com.mangofactory 
      </groupId> 
      
     
 
    
     
      
     
     
      
      <artifactId>swagger-springmvc 
      </artifactId> 
      
     
 
    
     
      
     
     
      
      <version>1.0.2 
      </version> 
      
     
 
    
     
      
     
     
      
      </dependency>

我在項目中使用的是SpringBoot框架，減小了不少的配置信息

在進行接口設計的Controller中，只須要使用Swagger註解。其中下面的@Api、@ApiOperaction、@Apiparam都是Swagger註解：

其中@Api表示這是一個須要Swagger表示的類寫在Controller的頭部，如圖；

@ApiOperaction表示這是一個須要Swagger修飾的接口，其中代表了請求方式、說明等信息。@ApiParam表示該接口輸入的參數：

value是參數的值說明；name表示變量名；paramType表示傳入類型，我所知類型：請求頭傳入寫query,JSON類型傳入寫json；defaultValue表示默認值；required表示參數是否必須傳。 API接口文檔標識的內容只用於註釋，沒有實際意義，表示必須傳入，只在文檔中提示，沒傳不提示報錯。若想判斷，可在參數前些@requestParam註解

寫好API註解文檔後，啓動項目。能夠在swagger.html中對接口進行模擬測試，簡單方便。

在對應字段中輸入測試值，點擊try it out請求接口，返會參數將在respnseBody中展現：

以上就是Swagger對接口管理和測試的簡單實用方法，另外它還能夠對Bean進行註釋和管理。
html

對於一個實體模型，須要使用swagger去標識。以下面的Student模型，其中的@ApiModel、@ApiModelProperty都是屬於Swagger的註解。若是須要在接口中返回模型對象，則須要使用如下的方式去註解。前端

  
  
  
  
   
 
    
     
      
     
     
     
       @ApiModel(value = "學生對象", description = "student") 
      
     
 
    
     
      
     
     
     
       public class Student { 
      
     
 
    
     
      
     
     
      
      
     
 
    
     
      
     
     
     
       @ApiModelProperty(value = "姓名", required = true) 
      
     
 
    
     
      
     
     
     
       String name; 
      
     
 
    
     
      
     
     
     
       @ApiModelProperty(value = "年齡", required = true) 
      
     
 
    
     
      
     
     
     
       String age; 
      
     
 
    
     
      
     
     
      
      
     
 
    
     
      
     
     
     
       public Student(String name, String age) { 
      
     
 
    
     
      
     
     
     
       this.name = name; 
      
     
 
    
     
      
     
     
     
       this.age = age; 
      
     
 
    
     
      
     
     
     
       } 
      
     
 
    
     
      
     
     
      
      
     
 
    
     
      
     
     
     
       public String getName() { 
      
     
 
    
     
      
     
     
     
       return name; 
      
     
 
    
     
      
     
     
     
       } 
      
     
 
    
     
      
     
     
      
      
     
 
    
     
      
     
     
     
       public void setName(String name) { 
      
     
 
    
     
      
     
     
     
       this.name = name; 
      
     
 
    
     
      
     
     
     
       } 
      
     
 
    
     
      
     
     
      
      
     
 
    
     
      
     
     
     
       public String getAge() { 
      
     
 
    
     
      
     
     
     
       return age; 
      
     
 
    
     
      
     
     
     
       } 
      
     
 
    
     
      
     
     
      
      
     
 
    
     
      
     
     
     
       public void setAge(String age) { 
      
     
 
    
     
      
     
     
     
       this.age = age; 
      
     
 
    
     
      
     
     
     
       } 
      
     
 
    
     
      
     
     
     
       }

我目前更多的使用Swagger管理API文檔，測試接口。管理Bean我的並不經常使用。能夠把Swagger理解爲接口文檔，後臺寫好的代碼能夠直接生成前端接口文檔頁面，接口調用這能夠經過這個頁面發送接口請求，進行接口測試或調用。對接方便。無奈的是，返回參數的接口文檔，仍是要本身寫啊。

Postman插件，postman只是Chrome瀏覽器一個控件，能夠嵌在Chrome中使用，也能夠單獨下載軟件版。用來測試接口很是隻方便。並且能夠分類管理測試過的接口。分享接口
java

它得好處就是能夠記憶測試的參數，Swagger畢竟是網頁打開，不少參數沒法保存。對家數據測試形成不小困擾，另外。設計到token權限的話，swagger中可能每次都須要模擬登陸，而postman在Header中保存Token信息。給測試帶來便利，按照程序員的尿性，我推薦postman。清晰整齊，一目瞭然。

那麼他如何與前端對接呢，寫接口文檔嗎？能夠，或者你可以讓你家前端本身也下載一個，你把你測試的接口整理給他。就看他願不肯意用咯。
程序員

總結：後臺測試，推薦使用Postman。可是最好養成寫Swagger的習慣，第一是能夠給前端看，讓他們參考。更重要的是postman中的測試可能會丟失。可是寫在代碼裏的Swagger永遠不會丟。
spring