SpringCloud/SpringBoot 的項(xiàng)目一定要前后分離，這就需要一個(gè)API文檔生成的工具，后端一定要和前端或者是移動(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ì)配置可參考開(kāi)源項(xiàng)目https://github.com/dounine/japi。

使用說(shuō)明

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

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

編譯打包

cd japi/javagradle install -xtest

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

cd japi/javagradle bootRun

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

cd japi/nodenode app.js

生成RESTFul文檔

maven項(xiàng)目

com.dounine.japi client 1.0

gradle項(xiàng)目

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

編輯resources/japi.properties配置文件

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

編寫(xiě)一個(gè)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;}

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

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)==> 用戶目錄/.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這類使用侵入式注解生成文檔的,JAPI是完全基于標(biāo)準(zhǔn)注釋生成的,支持強(qiáng)大的JSR303或者是自定義注解。

開(kāi)源精神

JAPI已完全開(kāi)源

最后

每天發(fā)布更多新鮮有含量的技術(shù)文章、總有一款適合你。

快關(guān)注我、把我打包帶走。

總結(jié)

以上是生活随笔為你收集整理的springboot api文档_SpringCloud/SpringBoot - 自动生成API文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。