中文字幕av专区_日韩电影在线播放_精品国产精品久久一区免费式_av在线免费观看网站

溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務條款》

SpringBoot是怎么自動生成API文檔的

發布時間:2021-08-02 13:53:22 來源:億速云 閱讀:215 作者:chen 欄目:開發技術

這篇文章主要講解了“SpringBoot是怎么自動生成API文檔的”,文中的講解內容簡單清晰,易于學習與理解,下面請大家跟著小編的思路慢慢深入,一起來研究和學習“SpringBoot是怎么自動生成API文檔的”吧!

前言

在做項目的時候,如果項目是前后分離的,后端一定要和前端或者是移動端對接接口,那么問題來了,接口是不是要自己寫給他們看,一般的會采用Excel或者Word來寫,高級一點的就采用API管理平臺手工錄入,一個項目有上千上萬個接口,天啊,這是多么大的工作量,在接口維護的時候更加痛苦,為了解決這樣的事我們可以借助 japi 這個項目來完成RESTFul文檔的自動生成,完全基于注釋生成,更多詳細配置可查看https://github.com/dounine/japi。

使用說明

克隆項目下來

git clone https://github.com/dounine/japi.git

編譯打包

cd japi/java
gradle install -xtest

運行JAPI后臺管理

cd japi/java
gradle bootRun

運行JAPI文檔界面

cd japi/node
node app.js

生成RESTFul文檔

maven項目

<dependency>
    <groupId>com.dounine.japi</groupId>
    <artifactId>client</artifactId>
    <version>1.0</version>
</dependency>

gradle項目

compile group: 'com.dounine.japi', name: 'client', version: '1.0'

編輯resources/japi.properties配置文件

japi.name=test
japi.uuid=43a600877430438596de3d330e4bd06e
japi.version=1.0.0
japi.author=lake
japi.url=http://192.168.0.123:8080
japi.description=this is project description.
japi.createTime=2017-02-23 10:44:44
japi.icon=/home/lake/github/japi/html/img/logo.png
japi.server=http://192.168.0.179:7778
japi.server.username=japi
japi.server.password=japi123

編寫一個action

/**
 * 獲取用戶列表
 * @param user 用戶信息
 * @return class User
 * @version v2
 */
@GetMapping(value = "v2/list")
public Result hots(@Validated({User.UserDEL.class}) User user) throws RuntimeException {

    return null;
}

編寫一個API生成類

JapiCreateTest.java

@Test
    public void testCreate(){
        JapiClient.setPrefixPath("/home/lake/github/test-japi/java/");//項目路徑前綴
        JapiClient.setpostfixPath("/src/main/java");//項目路徑后綴

        JapiClient.setProjectJavaPath("client");//主項目地扯
        JapiClient.setActionReletivePath("com/dounine/test-japi/action");//相對主項目action包所在路徑
        //JapiClient.setIncludeProjectJavaPath(new String[]{"api"});//主項目中關聯的其它項目包路徑
        JapiClient.setIncludePackages(new String[]{"com.dounine.test-japi"});//關聯的包,用于準確快速搜索
        JapiClient.saveHistory(true);//是否保留本地歷史版本
        JapiClient.setFlushServer(false);//強制同步本地與服務器所有的版本(會先刪除服務器以前的歷史版本)

        IProject project = ProjectImpl.init();
        JapiClientStorage japiClientStorage = JapiClientStorage.getInstance();
        japiClientStorage.setProject(project);
        japiClientStorage.autoSaveToDisk();//自動使用到本地磁盤==> 用戶目錄/.japi-client/
        new JapiClientTransfer().autoTransfer(japiClientStorage);//文件傳輸到主服務器.
    }

最后訪問瀏覽器 http://localhost:7777

就可看到RESTFul文檔登錄

SpringBoot是怎么自動生成API文檔的

使用自己的帳號登錄就可以看到所有項目

SpringBoot是怎么自動生成API文檔的

進入項目看詳細RESTFul接口

SpringBoot是怎么自動生成API文檔的

使用場景

JAPI最適合在SpringCloud這樣的分布式多模塊項目中使用,內置強大的正則表達式,這會讓代碼注釋更加規范,區別于swigger這類使用侵入式注解生成文檔的,JAPI是完全基于標準注釋生成的,支持強大的JSR303或者是自定義注解。

感謝各位的閱讀,以上就是“SpringBoot是怎么自動生成API文檔的”的內容了,經過本文的學習后,相信大家對SpringBoot是怎么自動生成API文檔的這一問題有了更深刻的體會,具體使用情況還需要大家實踐驗證。這里是億速云,小編將為大家推送更多相關知識點的文章,歡迎關注!

向AI問一下細節

免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。

AI

图木舒克市| 和政县| 彭阳县| 定南县| 盐亭县| 灌云县| 昭苏县| 都昌县| 新竹县| 大邑县| 额敏县| 鄂温| 墨江| 丁青县| 姚安县| 芒康县| 华阴市| 驻马店市| 仙桃市| 浦江县| 治县。| 荆州市| 古田县| 定襄县| 峨山| 鹤山市| 大兴区| 天峻县| 郓城县| 交城县| 连州市| 合肥市| 崇礼县| 凤凰县| 兰溪市| 葵青区| 三都| 永登县| 门头沟区| 琼中| 若尔盖县|