TP框架中的API文档自动生成

在ThinkPHP（简称TP）框架中，API文档的自动生成可以通过以下几种方法实现：

1. 使用Swagger-PHP： Swagger-PHP是一个用于生成API文档的库。要在TP框架中使用它，请按照以下步骤操作：

首先，通过Composer安装Swagger-PHP：

composer require zircote/swagger-php

然后，在项目中创建一个Swagger配置文件（例如：swagger.php），并添加以下内容：

<?php
use Zircote\Swagger\Swagger;

return new Swagger([
    'info' => [
        'version' => '1.0.0',
        'title' => 'ThinkPHP API Documentation',
        'description' => 'API documentation for ThinkPHP framework',
        'termsOfService' => 'http://www.example.com/terms/',
        'contact' => [
            'name' => 'Your Name',
            'email' => 'your.email@example.com',
            'url' => 'http://www.example.com',
        ],
        'license' => [
            'name' => 'Apache 2.0',
            'url' => 'http://www.apache.org/licenses/LICENSE-2.0',
        ],
    ],
]);

接下来，为API添加注释。在每个控制器和方法上添加Swagger注释，例如：

/**
 * @OA\Get(
 *   path="/api/users",
 *   summary="Get list of users",
 *   @OA\Response(
 *     response=200,
 *     description="Success",
 *     @OA\Schema(type="array", @OA\Items(ref="#/definitions/User"))
 *   ),
 *   @OA\Response(
 *     response=400,
 *     description="Bad Request"
 *   )
 * )
 */

最后，使用Swagger生成API文档。在项目根目录下运行以下命令：

php think swagger:generate

这将在public目录下生成一个名为swagger.json的文件，你可以使用Swagger UI或其他工具查看和测试API。

2. 使用ApiDoc： ApiDoc是一个用于自动生成API文档的工具。要在TP框架中使用它，请按照以下步骤操作：

首先，通过npm全局安装ApiDoc：

npm install apidoc -g

然后，在项目根目录下创建一个ApiDoc配置文件（例如：apidoc.json），并添加以下内容：

{
  "name": "ThinkPHP API Documentation",
  "version": "1.0.0",
  "description": "API documentation for ThinkPHP framework",
  "title": "ThinkPHP API Docs",
  "url": "http://www.example.com",
  "footer": "Copyright © 2021 Your Name",
  "templates": {
    "lang": "en"
  },
  "parse": {
    "require": ["path/to/your/controllers/*.php"]
  },
  "include": ["src/**/*.php"]
}

接下来，为API添加注释。在每个控制器和方法上添加ApiDoc注释，例如：

/**
 * @api {get} /api/users Get list of users
 * @apiGroup User
 * @apiVersion 1.0.0
 * @apiSuccessExample {json} Success-Response:
 *     HTTP/1.1 200 OK
 *     [
 *       {
 *         "id": 1,
 *         "name": "John Doe"
 *       }
 *     ]
 * @apiError Example
 *     HTTP/1.1 400 Bad Request
 *     {
 *       "error": "Invalid parameter"
 *     }
 */

最后，使用ApiDoc生成API文档。在项目根目录下运行以下命令：

apidoc -i src/ -o public/

这将在public目录下生成一个名为index.html的文件，你可以直接查看API文档。

以上就是在ThinkPHP框架中自动生成API文档的两种方法。你可以根据自己的需求选择合适的工具。