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

使用說明

克隆項目下來

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

編譯打包

cd japi/javagradle install -xtest

運行JAPI后臺管理

cd japi/javagradle bootRun

運行JAPI文檔界面

cd japi/nodenode app.js

生成RESTFul文檔

maven項目

com.dounine.japi client 1.0

gradle項目

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

編寫一個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文档_SpringCloud/SpringBoot - 自动生成API文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。