如何编写基于 Swagger-PHP 的 API 文档

<?php
 
require_once 'vendor/autoload.php';
 
use OpenApi\Annotations as OA;
 
/**
 * @OA\Info(title="My API", version="0.1")
 */
class SwaggerDefinition implements OpenApi\OpenApiInterface
{
    /**
     * @OA\Get(
     *     path="/api/resource.json",
     *     @OA\Response(response="200", description="An example resource")
     * )
     */
    public function getApiResource()
    {
        // 实现 API 逻辑
    }
 
    public function define()
    {
        // 这里可以定义更多的路由和响应
    }
}
 
$openapi = new OpenApi\StaticAnalyser();
$openapi->processAnnotations(new SwaggerDefinition());
 
$openapi->toJson();

这段代码演示了如何使用 Swagger-PHP 创建一个简单的 API 文档。首先，我们引入了必要的自动加载文件。接着，我们定义了一个类 SwaggerDefinition，并在其中使用了 OpenAPI 注解来描述一个 GET 请求的路由以及预期的响应。最后，我们实例化了 OpenApi\StaticAnalyser 类，并调用 processAnnotations 方法来处理我们的注解，然后将生成的 OpenAPI 定义转换为 JSON 格式。