1. 創(chuàng)建項(xiàng)目

2. 獲取api_key和api_token

1. 打開(kāi)設(shè)置

2. 獲取api_key和token

3. 生成文檔

1. 先cd進(jìn)入你的項(xiàng)目目錄，命令行模式下輸入：

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

下載完畢，編輯

vi showdoc_api.sh

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

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

chmod +x showdoc_api.sh

./showdoc_api.sh

3. 文檔注釋規(guī)范

想要生成文檔，需要按照規(guī)范進(jìn)行注釋：

示例：

/**

* showdoc

* @catalog 測(cè)試文檔/用戶相關(guān)

* @title 用戶登錄

* @description 用戶登錄的接口

* @method get

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

* @header token 可選 string 設(shè)備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

*/

以上示例顯示效果如下：

關(guān)鍵字

關(guān)鍵字

說(shuō)明

@catalog

生成文檔要放到哪個(gè)目錄。如果只是二級(jí)目錄，則直接寫(xiě)目錄名字。如果是三級(jí)目錄，而需要寫(xiě)二級(jí)目錄/三級(jí)目錄，即用/隔開(kāi)。如”一層/二層/三層”

@title

表示生成的文檔標(biāo)題

@description

是文檔內(nèi)容中對(duì)接口的描述信息

@method

接口請(qǐng)求方式。一般是get或者post

@url

接口URL。不要在URL中使用&符號(hào)來(lái)傳遞參數(shù)。傳遞參數(shù)請(qǐng)寫(xiě)在參數(shù)表格中

@header

可選。header說(shuō)明。一行注釋對(duì)應(yīng)著表格的一行。用空格或者tab符號(hào)來(lái)隔開(kāi)每一列信息。

@param

參數(shù)表格說(shuō)明。一行注釋對(duì)應(yīng)著表格的一行。用空格或者tab符號(hào)來(lái)隔開(kāi)每一列信息。

@json_param

可選。當(dāng)請(qǐng)求參數(shù)是json的時(shí)候，可增加此標(biāo)簽。請(qǐng)把json內(nèi)容壓縮在同一行內(nèi)。

@return

返回內(nèi)容。請(qǐng)把返回內(nèi)容壓縮在同一行內(nèi)。如果是json，程序會(huì)自動(dòng)進(jìn)行格式化展示。 如果是非json內(nèi)容，則原樣展示。

@return_param

返回參數(shù)的表格說(shuō)明。一行注釋對(duì)應(yīng)著表格的一行。用空格或者tab符號(hào)來(lái)隔開(kāi)每一列信息。

@remark

備注信息

@number

可選。文檔的序號(hào)。

總結(jié)

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

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。