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文檔登錄
使用自己的帳號登錄就可以看到所有項目
進入項目看詳細RESTFul接口
使用場景
JAPI最適合在SpringCloud這樣的分佈式多模塊項目中使用,內置強大的正則表達式,這會讓代碼註釋更加規范,區別於swigger這類使用侵入式註解生成文檔的,JAPI是完全基於標準註釋生成的,支持強大的JSR303或者是自定義註解。
開源精神
歡迎有意向的同學加入JAPI項目組將它改造得更好。
總結
到此這篇關於SpringBoot如何自動生成API文檔的文章就介紹到這瞭,更多相關SpringBoot自動生成API文檔內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- windows下使用 intellij idea 編譯 kafka 源碼環境
- java快速生成接口文檔的三種解決方案
- Java中如何快速構建項目腳手架的實現
- Gradle的基本使用
- 現代高效的java構建工具gradle的快速入門