一、到showdoc官方注冊賬號

官方地址https://www.showdoc.com.cn/
登錄并創建一個項目,如圖：

二、下載showdoc環境

再項目設置中有開發api,點開如下：

其中就是官方教程，簡單全面。showdoc基礎就是使用官方腳本
https://git-scm.com/download/win國內：這些都是showdoc官方推薦的，先安裝git再下載showdoc腳本。

三、配置

上述的環境和腳本下好了后，將腳本放在需要生成接口文檔的目錄下，并編輯：
api_key、api_token、url三個屬性，api_key和api_token都在上面的項目設置中復制粘貼即可，url默認是url=https://www.showdoc.com.cn/server/?s=/api/open/fromComments，但如果是使用開源版showdoc，則需要將地址改為http://xx.com/server/index.php?s=/api/open/fromComments，否則就不需要修改。

四、運行

首先再接口頭部寫上注釋，參考：
/**
* 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
*/
然后運行shoudoc腳本，然后就可以再自己showdoc工作臺的項目中看見接口了，示例：

總結

以上是生活随笔為你收集整理的Showdoc使用——接口文档的全部內容，希望文章能夠幫你解決所遇到的問題。

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