apidoc⽣成API⽂档,Thinkphp6使⽤ThinkPHP-ApiDoc 完结撒花.❀❀❀❀❀❀
TP6版本
安装
composer require hg/apidoc
去官⽹下载前端页⾯
下载完成后解压，将apidoc⽂件夹拷贝到你的项⽬ public ⽬录下
出现404错误
如果使⽤的nginx，通过rewrite⽅式代替php中的PATH_INFO,location块 / 通⽤匹配中加上
if (!-e $request_filename){
rewrite ^(.*)$ /index.php?s=$1 last;
break;
}
出现500错误
控制器中use⼀下
use hg\apidoc\annotation as Apidoc;
use app\utils\Abc;
⽬录app新建⽂件夹utils新建⽂件Abc.php
<?php
namespace app\utils;
use Doctrine\Common\Annotations\Annotation;
/**
* ⾃定义参数解释⽂件
* @package hg\apidoc\annotation
* @Annotation
* @Target({"METHOD","CLASS"})
*/
class Abc extends Annotation
{}
修改config⽂件夹下apidoc.php
//指定⽣成⽂档的控制器
php手机版下载
'controllers'        => [
'app\\controller\\Index',
],
基础注释
⽅法加⽰例注释，其他⽅法注释语法要对
/**
* @Apidoc\Title("基础的注释⽅法")
* @Apidoc\Desc("最基础的接⼝注释写法")
* @Apidoc\Url("/v1/baseDemo/base")
* @Apidoc\Method("GET")
* @Apidoc\Tag("测试基础")
* @Apidoc\Header("Authorization", require=true, desc="Token")
* @Apidoc\Param("username", type="string",require=true, desc="⽤户名" )
* @Apidoc\Param("password", type="string",require=true, desc="密码" )
* @Apidoc\Param("phone", type="string",require=true, desc="⼿机号" )
* @Apidoc\Param("sex", type="int",default="1",desc="性别" )
* @Apidoc\Returned("id", type="int", desc="新增⽤户的id")
*/
vscode安装

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。