springfox

春狐

建置狀態	覆蓋範圍	程式碼分析

聲納雲

關於

有關該專案的更多信息，請訪問 Springfox 網站或 http://springfox.github.io/springfox/

有用的連結

• 參考文檔
• 範例儲存庫
• 貢獻指南
• 核心貢獻者
• 開發與貢獻指南
• 變更日誌
• 開發環境
• 發布說明

入門

對於新項目

對於Maven

< dependency >
    < groupId >io.springfox</ groupId >
    < artifactId >springfox-boot-starter</ artifactId >
    < version >3.0.0</ version >
</ dependency >

對於搖籃

  implementation " io.springfox:springfox-boot-starter:<version> " 

從早期快照遷移

Spring引導應用程式

注意：希望得到回饋以使其變得更好

1. 刪除對springfox-swagger2明確依賴
2. 刪除任何@EnableSwagger2...註釋
3. 添加springfox-boot-starter依賴
4. Springfox 3.x 刪除了對guava 和其他第3 方庫的依賴（還不是零依賴！依賴spring 插件和用於註釋和模型的開放api 庫），因此如果您使用guava 謂詞/函數，則需要轉換為java 8 函數介面。

從現有 2.x 版本遷移

Spring引導應用程式

注意：希望得到回饋以使其變得更好

1. 刪除對springfox-swagger2明確依賴
2. 刪除@EnableSwagger2註釋
3. 添加springfox-boot-starter依賴
4. Springfox 3.x 刪除了對guava 和其他第3 方庫的依賴（還不是零依賴！依賴spring 插件和用於註釋和模型的開放api 庫），因此如果您使用guava 謂詞/函數，則需要轉換為java 8 函數接口
5. 如果您正在使用 WebMvc 但尚未使用@EnableWebMvc註解，請新增此註解。

常規 spring mvc

注意：希望得到回饋以使這種體驗變得更好

1. 刪除對springfox-swagger2明確依賴
2. 新增@EnableOpenApi用於開放API（以及@EnableSwagger2WebMvc或@EnableSwagger2WebFlux用於舊版）
3. 新增了springfox-oas庫
4. Springfox 3.x 刪除了對guava 和其他第3 方庫的依賴（還不是零依賴！依賴spring 插件和用於註釋和模型的開放api 庫），因此如果您使用guava 謂詞/函數，則需要轉換為java 8 函數接口

執照

版權所有 2015 馬蒂皮特 - @martypitt、迪利普克里希南 - @dilipkrish、阿德里安凱利 - @adrianbk、

根據 Apache 許可證 2.0 版（“許可證”）獲得許可；除非遵守許可證，否則您不得使用此文件。您可以在 apache.org/licenses/LICENSE-2.0 取得授權副本

除非適用法律要求或書面同意，否則根據許可證分發的軟體均以「原樣」分發，不帶任何明示或暗示的保證或條件。請參閱許可證，了解許可證下管理權限和限制的特定語言。

執照