亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

Java開發(fā)SpringBoot集成接口文檔實現(xiàn)示例

 更新時間:2021年10月27日 17:23:26   作者:飄渺Jam  
這篇文章主要為大家介紹了Java開發(fā)SpringBoot如何集成接口文檔的實現(xiàn)示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步

之前我在SpringBoot老鳥系列中專門花了大量的篇幅詳細介紹如何集成Swagger,以及如何對Swagger進行擴展讓其支持接口參數(shù)分組功能。

詳情可見:SpringBoot 如何生成接口文檔,老鳥們都這么玩的!

可是當我接觸到另一個接口文檔工具 smart-doc后,我覺得它比Swagger更適合集成在項目中,更適合老鳥們。今天我們就來介紹一下smart-doc組件的使用,作為對老鳥系列文章的一個補充。

swagger vs smart-doc

首先我們先看一下Swagger組件目前存在的主要問題:

Swagger的代碼侵入性比較強

這個很容易理解,要讓Swagger生成接口文檔必須要給方法或字段添加對應的注解,是存在代碼侵入的。

原生swagger不支持接口的參數(shù)分組

對于有做參數(shù)分組的接口,原生的Swagger并未支持,雖然我們通過擴展其組件可以讓其支持參數(shù)分組,但是畢竟要開發(fā),而且還未支持最新的Swagger3版本。

那作為對比,smart-doc 是基于接口源碼分析來生成接口文檔,完全做到零注解侵入,你只需要按照java標準注釋的寫,smart-doc就能幫你生成一個簡易明了的markdown 或是一個像GitBook樣式的靜態(tài)html文檔。官方地址:https://gitee.com/smart-doc-team/smart-doc

簡單羅列一下smart-doc的優(yōu)點

零注解、零學習成本、只需要寫標準java注釋即可生成文檔。

基于源代碼接口定義自動推導,強大的返回結(jié)構(gòu)推導。

支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller書寫方式)。

支持Callable,Future,CompletableFuture等異步接口返回的推導。

支持JavaBean上的JSR303參數(shù)校驗規(guī)范,支持參數(shù)分組。

對一些常用字段定義能夠生成有效的模擬值。…

接下來我們來看看SpringBoot中如何集成smart-doc。

SpringBoot集成 smart-doc

smart-doc支持多種方式生成接口文檔:maven插件、gradle插件、單元測試(不推薦),這里我才用的是基于maven插件生成,步驟如下:

引入依賴,版本選擇最新版本

<!--引入smart-doc-->
<plugin>
  <groupId>com.github.shalousun</groupId>
  <artifactId>smart-doc-maven-plugin</artifactId>
  <version>2.2.7</version>
  <configuration>
    <configFile>./src/main/resources/smart-doc.json</configFile>
    <projectName>Smart-Doc初體驗</projectName>
  </configuration>
</plugin>

重點在 configFile中指定smart-doc配置文件 smart-doc.json

新建配置文件smart-doc.json

{
  "outPath": "src/main/resources/static/doc"
}

指定smart-doc生成的文檔路徑,其他配置項可以參考官方wiki。

通過執(zhí)行maven 命令生成對應的接口文檔

//生成html
mvn -Dfile.encoding=UTF-8 smart-doc:html

當然也可以通過idea中的maven插件生成

圖片

訪問接口文檔

生成接口文檔后我們通過 http://localhost:8080/doc/api.html 查看,效果如下:

圖片

看到這里的同學可能會呵呵一笑,就這?啥也沒有呀!這還想讓我替換Swagger?

別急,剛剛只是體驗了smart-doc的基礎功能,接下來我們通過豐富smart-doc的配置文件內(nèi)容來增強其功能。

功能增強

1. 開啟調(diào)試

一個優(yōu)秀的接口文檔工具調(diào)試功能必不能少,smart-doc支持在線調(diào)試功能,只需要加入如下幾個配置項:

{
  "serverUrl": "http://localhost:8080",      -- 服務器地址
  "allInOne": true,                -- 是否將文檔合并到一個文件中,一般推薦為true
  "outPath": "src/main/resources/static/doc",  -- 指定文檔的輸出路徑
  "createDebugPage": true,           -- 開啟測試
  "allInOneDocFileName":"index.html",      -- 自定義文檔名稱
  "projectName": "初識smart-doc"        -- 項目名稱
}

通過"createDebugPage": true 開啟debug功能,在讓生成smart-doc生成文檔時直接放入到 static/doc/下,這樣可以直接啟動程序訪問頁面 http://localhost:8080/doc/index.html 進行開發(fā)調(diào)試。

圖片

有的開發(fā)人員直接在idea中使用【Open In Browser】打開smart-doc生成的debug頁面,如果非要這做,前端js請求后臺接口時就出現(xiàn)了跨域。因此你需要在后端配置跨域。

這里以 SpringBoot2.3.x 為例配置后端跨域:

@Configuration
public class WebMvcAutoConfig implements WebMvcConfigurer {

    @Bean
    public CorsFilter corsFilter() {
        final UrlBasedCorsConfigurationSource urlBasedCorsConfigurationSource = new UrlBasedCorsConfigurationSource();
        final CorsConfiguration corsConfiguration = new CorsConfiguration();
        /* 是否允許請求帶有驗證信息 */
        corsConfiguration.setAllowCredentials(true);
        /* 允許訪問的客戶端域名 */
        corsConfiguration.addAllowedOrigin("*");
        /* 允許服務端訪問的客戶端請求頭 */
        corsConfiguration.addAllowedHeader("*");
        /* 允許訪問的方法名,GET POST等 */
        corsConfiguration.addAllowedMethod("*");
        urlBasedCorsConfigurationSource.registerCorsConfiguration("/**", corsConfiguration);
        return new CorsFilter(urlBasedCorsConfigurationSource);
    }
}

開啟跨域后我們就可以直接在靜態(tài)接口頁面中進行調(diào)試了。

2. 通用響應體

在 “SpringBoot 如何統(tǒng)一后端返回格式?老鳥們都是這樣玩的!”一文中我們通過實現(xiàn) ResponseBodyAdvice對所有返回值進行了包裝,給前端返回統(tǒng)一的數(shù)據(jù)結(jié)構(gòu)ResultData,我們需要讓其在接口文檔中也有此功能,在配置文件追加配置內(nèi)容:

{
  "responseBodyAdvice":{            -- 通用響應體
    "className":"com.jianzh5.blog.base.ResultData"
  }
}

圖片

3. 自定義Header

在前后端分離項目中我們一般需要在請求接口時設置一個請求頭,如token,Authorization等…后端根據(jù)請求頭判斷是否為系統(tǒng)合法用戶,目前smart-doc也對其提供了支持。

在smart-doc配置文件 smart-doc.json中繼續(xù)追加如下配置內(nèi)容:

"requestHeaders": [ //設置請求頭,沒有需求可以不設置
    {
      "name": "token",//請求頭名稱
      "type": "string",//請求頭類型
      "desc": "自定義請求頭 - token",//請求頭描述信息
      "value":"123456",//不設置默認null
      "required": false,//是否必須
      "since": "-",//什么版本添加的改請求頭
      "pathPatterns": "/smart/say",//只有以/smart/say 開頭的url才會有此請求頭
      "excludePathPatterns":"/smart/add,/smart/edit" // url=/app/page/將不會有該請求頭
    }
]

效果如下:

圖片

4. 參數(shù)分組

演示一下smart-doc對于參數(shù)分組的支持

圖片

新增操作時,age、level為必填項,sex為非必填。

圖片

編輯操作時,id,appid,leven為必填項,sex為非必填。

通過上面的效果可以看出smart-doc對于參數(shù)分組是完全支持的。

5. idea配置doc

自定義的tag默認是不會自動提示的,需要用戶在idea中進行設置。設置好后即可使用,下面以設置smart-doc自定義的mock tag為例,設置操作如下:

圖片

6. 完整配置

附上完整配置,如果還需要其他配置大家可以參考wiki自行引入。

{
  "serverUrl": "http://localhost:8080",
  "allInOne": true,
  "outPath": "src/main/resources/static/doc",
  "createDebugPage": true,
  "allInOneDocFileName":"index.html",
  "projectName": "初識smart-doc",
  "packageFilters": "com.jianzh5.blog.smartdoc.*",
  "errorCodeDictionaries": [{
    "title": "title",
    "enumClassName": "com.jianzh5.blog.base.ReturnCode",
    "codeField": "code",
    "descField": "message"
  }],
  "responseBodyAdvice":{
    "className":"com.jianzh5.blog.base.ResultData"
  },
  "requestHeaders": [{
    "name": "token",
    "type": "string",
    "desc": "自定義請求頭 - token",
    "value":"123456",
    "required": false,
    "since": "-",
    "pathPatterns": "/smart/say",
    "excludePathPatterns":"/smart/add,/smart/edit"
  }]
}

小結(jié)

其實沒什么可總結(jié)的,smart-doc使用非常簡單,官方文檔也非常詳細,只要你會寫標準的java注釋就可以給你生成詳細的接口文檔。(如果你說你不會寫注釋,那這篇文章可能不太適合你) 而且在引入smart-doc后還可以強制要求開發(fā)人員給接口編寫注釋,保證團隊代碼風格不會出現(xiàn)很大差異。

以上就是Java開發(fā)SpringBoot集成接口文檔實現(xiàn)示例的詳細內(nèi)容,更多關于SpringBoot集成接口文檔的資料請關注腳本之家其它相關文章!

相關文章

  • 解決spring懶加載以及@PostConstruct結(jié)合的坑

    解決spring懶加載以及@PostConstruct結(jié)合的坑

    這篇文章主要介紹了解決spring懶加載以及@PostConstruct結(jié)合的坑,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2021-12-12
  • Java中單例模式詳解

    Java中單例模式詳解

    這篇文章主要介紹了Java中單例模式詳解,單例模式包括了懶漢式單例、餓漢式單例、登記式單例三種,想要了解的朋友可以了解一下。
    2016-11-11
  • SpringBoot創(chuàng)建多模塊項目的全過程記錄

    SpringBoot創(chuàng)建多模塊項目的全過程記錄

    這篇文章主要給大家介紹了關于SpringBoot創(chuàng)建多模塊項目的相關資料,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧
    2021-01-01
  • Java(基于Struts2) 分頁實現(xiàn)代碼

    Java(基于Struts2) 分頁實現(xiàn)代碼

    這篇文章介紹了Java(基于Struts2) 分頁實現(xiàn)代碼,有需要的朋友可以參考一下
    2013-10-10
  • spring 如何將配置信息注入靜態(tài)變量的方法

    spring 如何將配置信息注入靜態(tài)變量的方法

    本篇文章主要介紹了spring 如何將配置信息注入靜態(tài)變量的方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧
    2018-06-06
  • java實現(xiàn)手機短信驗證的基本思路

    java實現(xiàn)手機短信驗證的基本思路

    這篇文章主要為大家詳細介紹了java實現(xiàn)手機短信驗證的基本思路,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2017-11-11
  • springboot整合activity自動部署及部署文件命名流程

    springboot整合activity自動部署及部署文件命名流程

    這篇文章主要介紹了springboot整合activity自動部署及部署文件命名流程,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2021-09-09
  • java多線程實現(xiàn)文件下載功能

    java多線程實現(xiàn)文件下載功能

    這篇文章主要介紹了java多線程實現(xiàn)文件下載功能的相關資料,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2017-01-01
  • java中URLEncoder.encode與URLDecoder.decode處理url特殊參數(shù)的方法

    java中URLEncoder.encode與URLDecoder.decode處理url特殊參數(shù)的方法

    這篇文章主要給大家介紹了關于java中URLEncoder.encode與URLDecoder.decode處理url特殊參數(shù)的方法,文中介紹的非常詳細,需要的朋友可以參考借鑒,下面來一起看看吧。
    2017-03-03
  • 為什么阿里要慎重使用ArrayList中的subList方法

    為什么阿里要慎重使用ArrayList中的subList方法

    這篇文章主要介紹了為什么要慎重使用ArrayList中的subList方法,subList是List接口中定義的一個方法,該方法主要用于返回一個集合中的一段、可以理解為截取一個集合中的部分元素,他的返回值也是一個List。,需要的朋友可以參考下
    2019-06-06

最新評論