python的apidoc使用

一、apidoc的安裝

npm install apidoc -g

-g參數表示全局安裝，這樣在哪兒都能使用。

二、apidoc在python接口代碼中的使用

def index():
    """
    @api {GET} /index/？id=1 主頁操作
    @apiVersion 1.0.0
    @apiName index
    @apiGroup User
    @apiDescription 這里可以描述一下這個函數的具體操作
    這一行也是可以描述的

    @apiParam {String} name 姓名

    @apiSuccess {Object} status 狀態碼
    @apiSuccess {Object} msg 簡略描述
    @apiParamExample {Json} 請求參數示例
    {
      "name": "lili"
    }
    @apiSuccessExample {Json} 成功返回:
        HTTP 1.1/ 200K
        [
            {
                'id': 1,
                'name': '張三'
            }，
            {
                'id': 2,
                'name': '李四'
            },
            {
                'id': 3,
                'name': '王五'
            }
        ]

    @apiErrorExample Response-Fail:
        HTTP 1.1/ 404K
        {
            'status': 1,
            'msg': 'Fail'
        }
    """
    pass

三、在項目的根目錄下增加apidoc.json文件，如下：

四、生成apidoc網頁文件：

apidoc -i home_application -o static/apidoc

-i 代碼所在路徑 -o 生成文件的路徑

注意：該命令不要在pycharm的終端使用，因為找不到apidoc，沒有配置

最后會在static文件中生成apidoc文件夾，其中的index.html即生成的html文件。打開index.html，如下：