README

带有Laravel测试的API规范生成器

此包覆盖了json()函数，当你使用这些函数时，将会生成API规范。

你可以选择以下规范，

Rest
OpenAPI规范

用法

输出每个规范

只需将ApiSpec\ApiSpecTestCase作为基于API测试类的基类即可。

+use ApiSpec\ApiSpecTestCase;

class SomeTestCase extends ApiSpecTestCase
{

或使用特质ApiSpec\ApiSpecOutput

+use ApiSpec\ApiSpecOutput;

class SomeTestCase extends TestCase
{
    +use ApiSpecOutput;
    //...
}

聚合输出文件

在输出每个规范之后，此命令将所有规范聚合到一个文件中。（仅支持OAS模式）

php artisan apispec:aggregate

配置

此包提供配置文件apispec.php

return [
     // Whether to output spec files.
    'isExportSpec' => true,

     // Spec builder class name. You can choose ToOAS or ToHTTP.
    'builder'      => \ApiSpec\Builders\ToOAS::class,
];

输出

Rest

输出格式被多个IDE识别。

例如：PHPStorm，IntelliJ IDEA...(2017.3 EAP https://blog.jetbrains.com/phpstorm/2017/09/editor-based-rest-client/

OAS

输出格式是OpenAPI 3.0.0

以下是一些限制

安全方案类型仅支持JWT
所有请求体内容都有required标志
一些参数是硬编码的。

kotamat / laravel-apispec-generator

维护者

详细信息

README

用法

输出每个规范

聚合输出文件

配置

输出

Rest

OAS