webman開發(fā)框架可用的簡單的api-doc 注解文檔【新人小白一枚】

v1.0.0 版本

2022-06-29 版本更新時(shí)間

142 安裝

3 star

https://github.com/xianrenqh/api-doc-webman

api-doc-webman

webman開發(fā)框架可用的簡單的api-doc 文檔
【注解】
【新人小白一枚】

安裝

composer require xianrenqh/api-doc-webman

使用

配置設(shè)置：

基本配置
路徑：\config\plugin\xianrenqh\api-doc-webman\app.php

可以設(shè)置基本信息。

重要：

基本設(shè)置中： api_doc->下的 class 設(shè)置項(xiàng)，一定要設(shè)置成自己要加載的api接口文檔的類文件，多個(gè)用數(shù)組。

路由配置
路徑：\config\plugin\xianrenqh\api-doc-webman\route.php

路由設(shè)置里目前有兩個(gè)路由：

api文檔的前端訪問路由
apidoc開啟密碼訪問時(shí)，請(qǐng)求判斷密碼的校驗(yàn)地址路由

前端訪問地址：

默認(rèn)的：
http://127.0.0.1:8787/apidoc

你可以自行更改路由 apidoc 來定義訪問地址

api類文件的使用方法：

打開你要設(shè)置的注解的api類文件，

例如：\app\api\controller\UserController.php

在 class UserController 之前增加注解代碼：

/**
 * @title   會(huì)員Api
 * @desc    API接口
 * Class APi
 * @package app\api\controller
 */

在公共方法上增加注解代碼：

    /**
     * @title  會(huì)員登錄
     * @url    /api
     * @header string XX-token header傳遞的token 空 必須
     * @param string method 路由參數(shù) user.login 必須
     * @param string mobile 用戶名或手機(jī)號(hào) 空 必須
     * @param string password 登錄密碼 空 必須
     * @param int platform 平臺(tái)類型 1 否
     * @method POST
     * @code   200 成功
     * @code   0 失敗
     * @json {"code":0,"msg":"沒有找到此賬號(hào)","data":[]}
     * @return int code 狀態(tài)碼 （具體參見狀態(tài)碼說明）
     * @return string msg 提示信息
     */

來個(gè)控制器里的完整代碼，僅做參考

<?php

namespace app\api\controller;

use app\common\model\User as UserModel;

/**
 * @title   會(huì)員Api
 * @desc    API接口
 * Class APi
 * @package app\api\controller
 */
class UserController extends ApiController
{

    /**
     * @title  會(huì)員登錄
     * @url    /api
     *
     * @param string method 路由參數(shù) user.login 必須
     * @param string mobile 用戶名或手機(jī)號(hào) 空 必須
     * @param string password 登錄密碼 空 必須
     * @param int platform 平臺(tái)類型 1 否
     * @method POST
     *
     * @code   200 成功
     * @code   0 失敗
     * @json {"code":0,"msg":"沒有找到此賬號(hào)","data":[]}
     * @return int code 狀態(tài)碼 （具體參見狀態(tài)碼說明）
     * @return string msg 提示信息
     */
    public function user_login()
    {
        //你的邏輯，啦啦啦
    }
}