README

swagger-php

使用 OpenAPI 注解生成您的RESTful API的交互式文档。

功能

兼容OpenAPI 3.0规范。
出色的错误报告（带有提示和上下文）
从代码和现有的phpdoc注解中提取信息。
提供命令行界面。

安装（使用 Composer）

composer require sonrac/swagger-php-openapi

要从任何地方使用cli安装swagger-php全局版本，并确保将~/.composer/vendor/bin目录添加到您的PATH中，以便系统可以找到swagger可执行文件。

composer global require sonrac/swagger-php-openapi

用法

将注解添加到您的php文件中。

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

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

请参阅入门指南和示例目录以获取更多示例。

从PHP使用

生成始终是最新的文档。

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

从命令行界面使用

将swagger文档生成到静态json文件。

./vendor/bin/swagger --help

从反序列化器使用

从json字符串生成OpenApi注解对象，这使得以编程方式操作对象变得更容易。

<?php

use Swagger\Serializer;

$serializer = new Serializer();
$openapi = $serializer->deserialize($jsonString, 'Swagger\Annotations\OpenApi');
echo $openapi;

关于OpenAPI的更多信息

贡献

请随时提交GitHub问题或拉取请求。

文档网站位于gh-pages分支中。

请确保拉取请求通过PHPUnit和PHP_CodeSniffer（PSR-2）测试。

在项目的根目录中执行此命令以运行测试

./bin/phpunit

在本地机器上运行phpcs测试，请执行

./bin/phpcs -p --extensions=php --standard=PSR2 --error-severity=1 --warning-severity=0 ./src ./tests

运行单元测试和linting的命令是

composer test

sonrac / swagger-php-openapi

维护者

详细信息