Readme

Specs

Collection of code/annotation examples and their corresponding OpenAPI specs generated using swagger-php.

• api - Basic API
• misc
• nesting - Nested schemas and class hierachies
• petstore - Classic petstore
• polymorphism - Using @OA\Discriminator
• using interfaces
• using-links
• using refs
• using traits
• webhooks - Using @OA\Webhooks

Custom processors

Processors implement the various steps involved in converting the annotations collected into an OpenAPI spec.

Writing a custom processor is the recommended way to extend swagger-php in a clean way.

Processors are expected to implement the __invoke() method expecting the current Analysis object as single parameter:

<?php
...
use OpenApi\Analysis;
...

class MyCustomProcessor
{
    public function __invoke(Analysis $analysis)
    {
        // custom processing
    }
}

• schema-query-parameter processor

  A processor that takes a vendor tag (expecting a schema #ref) and injects all properties of that given schema as query parameter to the request definition.

• sort-components processor

  A processor that sorts components, so they appear in alphabetical order.