1. 程式人生 > >接口文檔自動生成工具apidoc

接口文檔自動生成工具apidoc

端口 分享 itl 通過 分離 資源 img 瀏覽器 nginx

  前後端分離之後,接口文檔是前後端溝通的必要手段。然後接口文檔包含大量的重復性工作,費時費力,像apidoc這樣工具就十分必要了。

  官方文檔:http://apidocjs.com/

  --------------------------------------------------------------------------------------------------

  首先說一下自己遇到的坑:

  1、安裝,node.js版本要高(在官網下最新的就行),不然後面有的模塊會出問題,導致apidoc無法使用。

  技術分享圖片

  2、生成接口文檔之後,把文檔放到服務器上面,發現接口文檔無法加載

技術分享圖片  看一下瀏覽器的請求,發現是有些資源無法加載,但是文件確實是存在的

  技術分享圖片

  後來發現是請求被nginx轉發到tomcat裏面了,修改一下nginx的配置文件即可,或者直接把文檔放到tomcat目錄下,通過其它端口(8080)訪問。

  技術分享圖片

接口文檔自動生成工具apidoc