1. 創建項目

2. 獲取api_key和api_token

1. 打開設置

2. 獲取api_key和token

3. 生成文檔

1. 先cd進入你的項目目錄，命令行模式下輸入：

wget https://www.showdoc.cc/script/showdoc_api.sh

下載完畢，編輯

vi showdoc_api.sh

腳本內容的前面有兩個變量，api_key 和 api_token ，這個需要用戶自行填寫。關于這兩個變量的取值，請登錄showdoc，進入某個項目的設置，點擊開放API，便可以看到說明。showdoc_api.sh生成的文檔會放進你填寫的這個項目里。除了api_key 和 api_token ，還有一個url變量。如果是使用www.showdoc.cc ，則不需要修改。如果是使用開源版showdoc，則需要將地址改為http://xx.com/server/index.php?s=/api/open/fromComments ，其中，別忘記了url里含server目錄。

保存文件后。執行以下命令，腳本會自動遞歸掃描本目錄和子目錄的所有文本代碼文件，并生成API文檔。

chmod +x showdoc_api.sh

./showdoc_api.sh

3. 文檔注釋規范

想要生成文檔，需要按照規范進行注釋：

示例：

/**

* showdoc

* @catalog 測試文檔/用戶相關

* @title 用戶登錄

* @description 用戶登錄的接口

* @method get

* @url https://www.showdoc.cc/home/user/login

* @header token 可選 string 設備token

* @param username 必選 string 用戶名

* @param password 必選 string 密碼

* @param name 可選 string 用戶昵稱

* @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吳系掛","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}

* @return_param groupid int 用戶組id

* @return_param name string 用戶昵稱

* @remark 這里是備注信息

* @number 99

*/

以上示例顯示效果如下：

關鍵字

關鍵字

說明

@catalog

生成文檔要放到哪個目錄。如果只是二級目錄，則直接寫目錄名字。如果是三級目錄，而需要寫二級目錄/三級目錄，即用/隔開。如”一層/二層/三層”

@title

表示生成的文檔標題

@description

是文檔內容中對接口的描述信息

@method

接口請求方式。一般是get或者post

@url

接口URL。不要在URL中使用&符號來傳遞參數。傳遞參數請寫在參數表格中

@header

可選。header說明。一行注釋對應著表格的一行。用空格或者tab符號來隔開每一列信息。

@param

參數表格說明。一行注釋對應著表格的一行。用空格或者tab符號來隔開每一列信息。

@json_param

可選。當請求參數是json的時候，可增加此標簽。請把json內容壓縮在同一行內。

@return

返回內容。請把返回內容壓縮在同一行內。如果是json，程序會自動進行格式化展示。 如果是非json內容，則原樣展示。

@return_param

返回參數的表格說明。一行注釋對應著表格的一行。用空格或者tab符號來隔開每一列信息。

@remark

備注信息

@number

可選。文檔的序號。

總結

以上是生活随笔為你收集整理的showdoc如何创建文件夹_showDoc生成文档的全部內容，希望文章能夠幫你解決所遇到的問題。

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