前后端分離之后,接口文檔是前后端溝通的必要手段。然后接口文檔包含大量的重復性工作,費時費力,像apidoc這樣工具就十分必要了。
官方文檔:http://apidocjs.com/
--------------------------------------------------------------------------------------------------
首先說一下自己遇到的坑:
1、安裝,node.js版本要高(在官網下最新的就行),不然后面有的模塊會出問題,導致apidoc無法使用。
2、生成接口文檔之后,把文檔放到服務器上面,發現接口文檔無法加載
看一下瀏覽器的請求,發現是有些資源無法加載,但是文件確實是存在的
后來發現是請求被nginx轉發到tomcat里面了,修改一下nginx的配置文件即可,或者直接把文檔放到tomcat目錄下,通過其它端口(8080)訪問。
3、同一個apiGroup下的多個接口,生成出來時只有部分接口
在同一個@apiGroup下,名稱@apiName相同的@api通過@apiVersion區分,否則后面@api會覆蓋前面定義的@api,要確保每個接口的@apiName不相同。