Download the PHP package fillincode/swagger without Composer

Swagger-parser

Installation

Публикация конфигурации

Config

OpenApi version

Block configuration with information about your Api. You can define the title, description, version, terms of use, contact details and license

Ready-made authorization schemes

Information on the server to which requests will be sent

Server authorization configuration

1. It is necessary to determine whether there are requests that require authorization
2. Middleware, which checks authorization
3. Select the desired authorization scheme
4. You need to define a function or Invokable class that will return the authorization token(s). You can return an array with a description of the token and its value or just a string token

An example of such a class

`

public function __invoke(): string|array
{
    $user = User::whereEmail('[email protected]')->first();
    $admin = User::whereEmail('[email protected]')->first();

    return [
        'user' => $user?->createToken('user-token')->accessToken,
        'admin' => $admin?->createToken('admin-token')->accessToken
    ];
}

shell php artisan swagger:destroy shell php artisan swagger:parse shell php artisan swagger:generate

FormRequest

The attribute is needed to indicate the FormRequest class by which data will be collected to describe the parameters passed in the request

Applicable:

1. Controller method

The parameter accepts:

1. Class (string). Required

Example:

Property

The attribute describes the parameter that is passed in the request or returned in the response

Applicable:

1. FormRequest class
2. Resource class

The parameter accepts:

1. Name (string). Required
2. Type (string). Required
3. Description (string).
4. In (string|array). Available values, parameter needed only for enum type
5. is_required (bool). Default true

Example:

`

[Property('age', 'integer', 'student age')]

class ProjectResource extends JsonResource
{
    //
}

## Additionally

An example when a resource has an array whose keys need to be documented