jobins/api-generator

Generate api docs while writing test case (Laravel).

v0.0.9 2022-10-19 03:53 UTC

Requires

• php: ^7.4|^8.0|^8.1
• ext-json: *

Requires (Dev)

• orchestra/testbench: ^6.15
• phpunit/phpunit: ^9.0
• vimeo/psalm: ^4.7

MIT

• Bedram Tamang

• documentation
• api
• phpunit
• swagger
• openapi
• jobins

README

Generate api docs while writing test case (Laravel).

Idea

It generates api docs with OpenAPI Specification while wiring test case in laravel application. The generated docs can preview on swagger ui either integrate laravel-swagger-ui on application or Swagger Editor online.

Features

• All basic setup features as available in swagger api.
• Request body will define using Laravel FormRequest class.
• The Request body example will grab from test data that used on testing.
• Route parameters will define from Laravel route.
• Response example grabs from the test responses.

Installation

composer require jobins/api-generator --dev

Publish assets

php artisan vendor:publish --provider="Jobins\APIGenerator\APIGeneratorServiceProvider"

Basic Uses

<?php

namespace Tests\Feature;

use App\Http\Requests\RegistrationRequest;
use JoBins\APIGenerator\Security\Bearer;
use JoBins\APIGenerator\Traits\HasDocsGenerator;

class RegistrationTest extends TestCase
{
    use HasDocsGenerator;
    
    /** @test */
    public function it_register_a_new_user()
    {
        $responseSchema = [
            "description" => "A User Object",
            "define"      => [
                "data.*"  => ["refSchema" => "UserSchema"],
                "message" => "Message for user",
            ],
        ];
        
        $this->setSummary("Register a new user.")
            ->setId("Register")
            ->setSecurity([Bearer::class])
            ->setTags(["Posts"])
            ->setRulesFromFormRequest(RegistrationRequest::class)
            ->defineResponseSchema($responseSchema)
            ->jsond("post", route("registration.store"), $data)
            ->assertStatus(422)
            ->assertJsonFragment([])
            ->assertJsonStructure(["message"])
            ->generate($this, true);    
    }
}

Define parameters in descriptions method of FormRequest class.

/**
 * Class ExampleFormRequest
 * @package JoBins\APIGenerator\Tests\Stubs
 */
class ExampleFormRequest extends FormRequest
{
    public function rules()
    {
        return [
            "email"     => "required", // Required, String, 
            "nickname"  => "sometimes|required", // Optional Field, String
        ];
    }

    public function descriptions()
    {
        return [
            "email"     => "Email of a new user.",
            "nickname"  => "Nick name of a new user."
        ];
    }
}