kotamat/laravel-apispec-generator

RestAPI spec generator with Laravel test

Laravel API Spec Generator

API Spec generator with Laravel test, _(*1)

This Package overrides json() When you use those function, API specs are going to be generated., _(*2)

You can select spec below,, _(*3)

• Rest
• OpenAPI Specification

Usage

Output each specs

Just use ApiSpec\ApiSpecTestCase as base class for API-based test classes., _(*4)

+use ApiSpec\ApiSpecTestCase;

class SomeTestCase extends ApiSpecTestCase
{

or use trait ApiSpec\ApiSpecOutput, _(*5)

+use ApiSpec\ApiSpecOutput;

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

Aggregate output files

After Output each specs, this command aggregates all specs in one file. (only supports OAS mode), _(*6)

php artisan apispec:aggregate

Configurations

This package provides config file as apispec.php, _(*7)

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

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

Output

Rest

The output format is recognized on several IDE., _(*8)

ex) PHPStorm, IntelliJ IDEA...(2017.3 EAP https://blog.jetbrains.com/phpstorm/2017/09/editor-based-rest-client/, _(*9)

OAS

The output format is OpenAPI 3.0.0, _(*10)

Restrictions are below, _(*11)

• Security Scheme type supports only JWT
• All request body contents have required flag
• Some parameters hard coded.