安裝和簡單使用apidoc

2022-06-03 00:51:24 字數 560 閱讀 9754

安裝nodejs

參考鏈結

安裝apidoc

參考鏈結

使用注意先cd到對應的路徑,再去生成文件

cd /d d:\project\think518
每次修改 都需要 執行以下上的命令

/**

** @apiname liststorage +方法名

* @apigroup alterstorage 倉儲員&倉庫 +控制器

* @apidescription 列出該倉儲員相關的倉庫資訊 +描述

** @apiparam account 賬號 +i 傳入

** @apierror code 0

* @apierror msg 資訊

* @apierror data 資料

* @apierror data.storagename 倉庫名

* @apierror data.storageuuid 倉庫uuid

**/

return 和private 的方法可以不用寫介面

APIDOC安裝使用

1 安裝node 2 修改node預設映象 npm config list檢視配置項 npm config set registry 3 全域性安裝apidoc npm install apidoc g 4 新建資料夾demo 5 建立apidoc.json檔案和test.php檔案 apidoc....

APIDOC使用教程

nodejs install apidoc install npm install g apidocinstall check 使用win r快捷鍵開啟執行視窗,在文字框中輸入cmd並回車開啟windows shell。node v npm v apidoc vrun command 引數 描述 i...

api文件生成器apidoc的安裝和使用

在開發介面的過程中,需要向外發布相應的介面文件。開始的時候使用word來寫文件,時間長了發現有幾個問題。1.編寫不方便。每次新增藉口的時候都要複製上乙個介面,然後再進行修改,一些相同的部分無法復用,介面多了文件會變的很長,還經常需要調整格式。2.發布不方便。文件更新時,需要發給需要的小夥伴。即使用g...