swagger文件註解使用

效果圖：

controller註解

這裡給引數新增註解，我傾向於使用下面這種

@apiimplicitparams()

public zingresult selectallusers(integer page, integer size) 

public zingresult selectone(@apiparam(name="page",value="頁碼",required=true) integer page,@apiparam(name="size",value="頁面數量",required=true) integer size)

效果圖

3 swagger文件配置類

3.1配置檔案

swagger.enable = true

#swagger api配置
swagger.title = 基礎平台 restful apis
swagger.desc = 基礎平台 restful 風格的介面文件，內容詳細，極大的減少了前後端的溝通成本，同時確保**與文件保持高度一致，極大的減少維護文件的時間。

配置類需要注入到ioc容器中

"swagger2config" class="com.zing.swagger.swagger2config"/>

/** * 配置swagger資訊
* *@author 於雲秀
*///啟用swagger2
@enableswagger2
public
class
swagger2config
extends
webmvcconfigurationsupport ")
private
boolean swaggerenable;
@value("$")
private string swaggertitle;
@value("$")
private string swaggerdesc;
@bean
public docket createrestapi() 
@bean
private apiinfo apiinfo() 
@override
public
void
addresourcehandlers(resourcehandlerregistry registry) }}

屬性檔案中存在中文，則需要在載入屬性檔案的時候指定編碼格式，根據需要選擇以下3種

• 使用propertyplaceholderconfigurer載入

class="org.springframework.beans.factory.config.propertyplaceholderconfigurer">

name="locations">
classpath:dubbo-server.propertiesvalue>
classpath:server.propertiesvalue>
list>
property>
name="fileencoding"
value="utf-8" />
bean>

• 使用註解載入

@propertysource(value = "classpath:conf/copywriteui.properties",encoding = "utf-8")

Swagger 文件常用註解

引用自 常用註解及屬性 api 用在請求的類上，表示對類的說明 apioperation 用在請求的方法上，說明方法的用途 作用 apiparam 單個引數描述 apimodel 用物件來接收引數 apimodelproperty 用物件接收引數時，描述物件的乙個字段 apiignore 使用該註解...

Swagger 註解使用

首先我們通過swagger的原始碼可以看到有很多的註解，下面這張截圖應該可以包括swagger的所有註解。註解名稱 使用說明 api api 用在類上，說明該類的作用。可以標記乙個 controller 類作為 swagger 文件資源,所以一般用在controller介面中，在swagger頁面上...

Swagger文件使用

有很多人不清楚swagger ui的路徑，由於我們使用了更為好用的swagger bootstrap ui，實際上使 網域名稱 埠 doc.html，如 http localhost 8080 doc.html 在沒有swagger之前，我們需要自己手寫文件，手寫文件的出現問題 文件更新時需要要與前...