快速入门

使用 Swagger-PHP 为你的 RESTful API 生成 OpenAPI 文档。

用户指南

符合 OpenAPI 规范

生成 3.0 或 3.1 版本的 OpenAPI 文档。

在 PHP 源代码中编写 API 文档

使用 swagger-php 可以在 PHP 源文件中编写 API 文档，这有助于保持文档的实时更新。

支持注解（Annotation）和属性（Attribute）

注解可以是 docblocks 或 PHP 8.1 属性。

使用

1. 使用 composer 安装

   composer require zircote/swagger-php
   

2. 更新你的代码
   将 swagger-php 属性（或旧版注解）添加到你的源代码中。
   doctrine/annotations 将来会被弃用，因此在可能的情况下应优先使用属性。
   AttributesAnnotations

   <?php
   
   use OpenApi\Attributes as OA;
   
   #[OA\Info(title: 'My First API', version: '0.1')]
   class OpenApi
   {
   }
   
   class MyController
   {
       #[OA\Get(path: '/api/data.json', operationId: 'getData')]
       #[OA\Response(response: '200', description: 'The data')]
       public function getResource()
       {
           // ...
       }
   }
   

3. 生成 OpenAPI 文档

   ./vendor/bin/openapi src -o openapi.yaml
   

4. 探索和交互你的 API
   使用像 Swagger UI 这样的 OpenAPI 工具来探索和与你的 API 进行交互。