前後端分離之後，介面文件是前後端溝通的必要手段。然後介面文件包含大量的重複性工作，費時費力，像apidoc這樣工具就十分必要了。
官方文件：
首先說一下自己遇到的坑：
1、安裝，node.js版本要高（在官網下最新的就行），不然後面有的模組會出問題，導致apidoc無法使用。
2、生成介面文件之後，把文件放到伺服器上面，發現介面文件無法載入
看一下瀏覽器的請求，發現是有些資源無法載入，但是檔案確實是存在的
後來發現是請求被nginx**到tomcat裡面了，修改一下nginx的配置檔案即可，或者直接把文件放到tomcat目錄下，通過其它埠（8080）訪問。
3、同乙個apigroup下的多個介面，生成出來時只有部分介面
在同乙個@apigroup下，名稱@apiname相同的@api通過@apiversion區分，否則後面@api會覆蓋前面定義的@api，要確保每個介面的@apiname不相同。
自動生成介面文件
rest framework可以自動幫助我們生成介面文件。介面文件以網頁的方式呈現。自動介面文件能生成的是繼承自apiview及其子類的檢視。rest framewrok生成介面文件需要coreapi庫的支援。pip install coreapi 在總路由中新增介面文件路徑。文件路由對應的檢視配置...
自動生成介面文件
目錄4 訪問介面文件網頁 5 兩點說明 rest framework可以自動幫助我們生成介面文件。介面文件以網頁的方式呈現。自動介面文件能生成的是繼承自apiview及其子類的檢視。rest framewrok生成介面文件需要coreapi庫的支援。pip install coreapi在總路由中新...
介面文件生成工具 apidoc
apidoc在您的源 中通過建立api注釋從而生成api說明文件。我們以express的專案為例 1 建立apidoc.json 2 我們在routes資料夾下建立api資料夾，用於書寫介面注釋說明,例如 api news newscontent 新聞詳情 apiversion 1.0.0 apin...