swagger api工具 PHP组件 ---- 1

 

1. 安装

composer require zircote/swagger-php

 

2.使用

　　生成最新文档

<?php
require("vendor/autoload.php");
$openapi = \OpenApi\scan('/path/to/project');
header('Content-Type: application/x-yaml');
echo $openapi->toYaml();

　　引入自动加载文件，设置文件路径，这将扫描给定文件夹中的PHP文件，查找OpenApi注释并输出一个json文件，将json文件付给swagger-ui，即可展示。

3.CLI

./vendor/bin/openapi --help

4.写注释

　　swagger-php的目标是使用phpdoc批注生成openapi.json。

/**
 * @OA\Info(title="My First API", version="0.1")
 */

/**
 * @OA\Get(
 *     path="/api/resource.json",
 *     @OA\Response(response="200", description="An example resource")
 * )
 */

　　swagger-php将生成yaml格式，内容如下：

openapi: 3.0.0
info:
  title: "My First API"
  version: "0.1"
paths:
  /api/resource.json:
    get:
      responses:
        "200":
          description: "An example resource"