快捷導(dǎo)航

SpringBoot如何自動(dòng)生成API文檔詳解

更新時(shí)間：2021年07月31日 13:28:48 作者：kikiki2

網(wǎng)絡(luò)程序正朝著移動(dòng)設(shè)備的方向發(fā)展,前后端分離、APP,最好的交互交互方式莫過(guò)于通過(guò)API接口實(shí)現(xiàn),這篇文章主要給大家介紹了關(guān)于SpringBoot如何自動(dòng)生成API文檔的相關(guān)資料,需要的朋友可以參考下

前言

在做項(xiàng)目的時(shí)候，如果項(xiàng)目是前后分離的，后端一定要和前端或者是移動(dòng)端對(duì)接接口，那么問(wèn)題來(lái)了，接口是不是要自己寫(xiě)給他們看，一般的會(huì)采用Excel或者Word來(lái)寫(xiě)，高級(jí)一點(diǎn)的就采用API管理平臺(tái)手工錄入，一個(gè)項(xiàng)目有上千上萬(wàn)個(gè)接口，天啊，這是多么大的工作量，在接口維護(hù)的時(shí)候更加痛苦，為了解決這樣的事我們可以借助 japi 這個(gè)項(xiàng)目來(lái)完成RESTFul文檔的自動(dòng)生成，完全基于注釋生成，更多詳細(xì)配置可查看https://github.com/dounine/japi。

使用說(shuō)明

克隆項(xiàng)目下來(lái)

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

編譯打包

cd japi/java
gradle install -xtest

運(yùn)行JAPI后臺(tái)管理

cd japi/java
gradle bootRun

運(yùn)行JAPI文檔界面

cd japi/node
node app.js

生成RESTFul文檔

maven項(xiàng)目

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

gradle項(xiàng)目

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

編寫(xiě)一個(gè)action

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

    return null;
}

編寫(xiě)一個(gè)API生成類(lèi)

JapiCreateTest.java

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

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

        IProject project = ProjectImpl.init();
        JapiClientStorage japiClientStorage = JapiClientStorage.getInstance();
        japiClientStorage.setProject(project);
        japiClientStorage.autoSaveToDisk();//自動(dòng)使用到本地磁盤(pán)==> 用戶(hù)目錄/.japi-client/
        new JapiClientTransfer().autoTransfer(japiClientStorage);//文件傳輸?shù)街鞣?wù)器.
    }

最后訪問(wèn)瀏覽器 http://localhost:7777

就可看到RESTFul文檔登錄

使用自己的帳號(hào)登錄就可以看到所有項(xiàng)目

進(jìn)入項(xiàng)目看詳細(xì)RESTFul接口

使用場(chǎng)景

JAPI最適合在SpringCloud這樣的分布式多模塊項(xiàng)目中使用，內(nèi)置強(qiáng)大的正則表達(dá)式，這會(huì)讓代碼注釋更加規(guī)范，區(qū)別于swigger這類(lèi)使用侵入式注解生成文檔的,JAPI是完全基于標(biāo)準(zhǔn)注釋生成的,支持強(qiáng)大的JSR303或者是自定義注解。

開(kāi)源精神

歡迎有意向的同學(xué)加入JAPI項(xiàng)目組將它改造得更好。