1、是一款讓你更好的書寫api文件的規範且完整框架。
2、提供描述、生產、消費和視覺化restful web service。
3、是由龐大工具集ruhe合支撐的形式化規範。這個集合涵蓋了從最終使用者介面、底層**庫到商業api管理的方方面面。
1.與springboot專案整合 *****>
在pom.xml檔案中新增swagger相關依賴
io.springfox
springfox-swagger2
2.8.0
io.springfox
springfox-swagger-ui
2.8.0
***************************
***************************
description:
parameter 0 of method linkdiscoverers in org.springframework.hateoas.config.hateoasconfiguration required a single bean, but 15 were found:
- modelbuilderpluginregistry: defined in null
- modelpropertybuilderpluginregistry: defined in null
- typenameproviderpluginregistry: defined in null
- documentationpluginregistry: defined in null
- apilistingbuilderpluginregistry: defined in null
- operationbuilderpluginregistry: defined in null
- parameterbuilderpluginregistry: defined in null
- expandedparameterbuilderpluginregistry: defined in null
- resourcegroupingstrategyregistry: defined in null
- operationmodelsproviderpluginregistry: defined in null
- defaultsproviderpluginregistry: defined in null
- pathdecoratorregistry: defined in null
- relproviderpluginregistry: defined by method 'relproviderpluginregistry' in class path resource [org/springframework/hateoas/config/hateoasconfiguration.class]
- linkdiscovererregistry: defined in null
- entitylinkspluginregistry: defined by method 'entitylinkspluginregistry' in class path resource [org/springframework/hateoas/config/webmvcentitylinksconfiguration.class]
@configuration //等價於 @component
@enableswagger2 //開啟swagger2
public class swagger2
完事了！！！ 這就成功了 。
真正開發情況下，swagger配置得配全面。繼續往下看把。
@configuration //等價於 @component
@enableswagger2 //開啟swagger2
public class swagger2
//編寫swagger 資訊，可在ui頁面顯示
private apiinfo apiinfo()
}
@restcontroller
@component
@api(value = "測試介面",tags = "測試") //
1、@api()：用在請求的類上，表示對類的說明，也代表了這個類是swagger2的資源
引數：
tags：說明該類的作用，引數是個陣列，可以填多個。
value="該引數沒什麼意義，在ui介面上不顯示，所以不用配置"
description = "使用者基本資訊操作"
2、@apioperation()：用於方法，表示乙個http請求訪問該方法的操作
引數：
value="方法的用途和作用"
notes="方法的注意事項和備註"
tags：說明該方法的作用，引數是個陣列，可以填多個。
格式：tags=
（在這裡建議不使用這個引數，會使介面看上去有點亂，前兩個常用）
3、@apimodel()：用於響應實體類上，用於說明實體作用
引數：
description="描述實體的作用"
4、@apimodelproperty：用在屬性上，描述實體類的屬性
引數：
value="使用者名稱" 描述引數的意義
name="name" 引數的變數名
required=true 引數是否必選
5、@apiimplicitparams：用在請求的方法上，包含多@apiimplicitparam
6、@apiimplicitparam：用於方法，表示單獨的請求引數
引數：
name="引數ming"
value="引數說明"
datatype="資料型別"
paramtype="query" 表示引數放在**
· header 請求引數的獲取：@requestheader
· query 請求引數的獲取：@requestparam
· path（用於restful介面） 請求引數的獲取：@pathvariable
· body（不常用）
· form（不常用）
defaultvalue="引數的預設值"
required="true" 表示引數是否必須傳
7、@apiparam()：用於方法，引數，字段說明 表示對引數的要求和說明
引數：
name="引數名稱"
value="引數的簡要說明"
defaultvalue="引數預設值"
required="true" 表示屬性是否必填，預設為false
8、@apiresponses：用於請求的方法上，根據響應碼表示不同響應
乙個@apiresponses包含多個@apiresponse
9、@apiresponse：用在請求的方法上，表示不同的響應
引數：
code="404" 表示響應碼(int型)，可自定義
message="狀態碼對應的響應資訊"
10、@apiignore()：用於類或者方法上，不被顯示在頁面上
11、@profile()：用於配置類上，表示只對開發和測試環境有用
LESS簡介與使用方法
less 是一門 css 預處理語言，它擴充套件了 css 語言，增加了變數 mixin 函式等特性，使 css 更易維護和擴充套件。content ul.content li.content li a content ul 以 開始的注釋，不會被編譯到 css 檔案中 以 包裹的注釋會被編譯到 c...
sscanf與sprintf使用方法簡介
sscanf從單詞上可以理解為string scanf，sprintf從單詞上可以理解為string printf scanf screen,d n printf screen,d,n scanf實際上是把螢幕上輸入的類容以 d的格式傳到n中 即從左到右 而printf的輸出實際是把n以 d的形式顯...
void 的使用方法簡介
void 的使用方法簡介 void的含義 void 意思就是 無型別 而void 表示 無型別指標 可以指向任何型別的資料。主要用途分兩種 一 對函式返回的限定。eg a 修飾函式時，表示函式無返回值 void fun unsigned char a,unsigned char b 這裡的void就...