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\\\Abc;

⽬录app新建⽂件夹utils新建⽂件Abc.php

namespace app\;

use Doctrine\\Common\\Annotations\\Annotation;/**

* ⾃定义参数解释⽂件

* @package hg\\apidoc\\annotation * @Annotation

* @Target({\"METHOD\ */

class Abc extends Annotation{}

修改config⽂件夹下apidoc.php

//指定⽣成⽂档的控制器 'controllers' => [

'app\\\\controller\\\\Index', ],

基础注释

⽅法加⽰例注释,其他⽅法注释语法要对

/**

* @Apidoc\\Title(\"基础的注释⽅法\")

* @Apidoc\\Desc(\"最基础的接⼝注释写法\") * @Apidoc\\Url(\"/v1/baseDemo/base\") * @Apidoc\\Method(\"GET\") * @Apidoc\\Tag(\"测试 基础\")

* @Apidoc\\Header(\"Authorization\

* @Apidoc\\Param(\"username\⽤户名\" ) * @Apidoc\\Param(\"password\密码\" ) * @Apidoc\\Param(\"phone\⼿机号\" ) * @Apidoc\\Param(\"sex\性别\" ) * @Apidoc\\Returned(\"id\新增⽤户的id\") */

vscode安装