tp5.1 使用apidoc

最新推荐文章于 2024-08-13 08:38:31 发布

原创

最新推荐文章于 2024-08-13 08:38:31 发布 · 1.6k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#php #tp5.1 #apidoc

本文介绍了如何在ThinkPHP5.12环境中安装并配置ApiDoc插件，通过实例演示了如何为控制器添加注解以生成接口文档，同时提供了配置文件的详细设置，帮助开发者快速上手API接口文档管理。

1. 安装tp5.1
2. 安装apidoc插件

打开浏览器访问 http://你的域名/apidoc/ ，出现接口文档页面，表示安装成功。

如出现404错误请访问以下链接排错：

页面404错误 | ThinkPHP-ApiDoc

简单使用：

以 app\index\controller\index 控制器为例

<?php
namespace app\index\controller;
// 添加这句，注释写法为 @Apidoc\参数名(...)
use hg\apidoc\annotation as Apidoc;

/**
 * @Apidoc\Title("首页控制器")
 * @Apidoc\Group("index")
 */

class Index
{
    public function index()
    {
        return '<style type="text/css">*{ padding: 0; margin: 0; } div{ padding: 4px 48px;} a{color:#2E5CD5;cursor: pointer;text-decoration: