README

Installation

Standalone

• Clone project

• Run composer update

• Check src/Document directory as sample and create your own OpenApiOperationGenerator and OpenApiDocumentGenerator

  OpenApiOperationGenerator is responsible to generate Open API Operations and OpenApiDocumentGenerator is responsible to generate Open API json document. Each public method of OpenApiOperationGenerator generates one Open API Operation (Using reflection).

• Run php -S localhost:8001 in project root directory

  • Open http://loclahost:8001 in your browser for Open API json document
  • Open http://loclahost:8001?swagger in your browser for Open API Swagger UI

Dependency of existing project

• Install package

  composer require alireza-h/php-openapi

• Check src/Document directory as sample and create your own OpenApiOperationGenerator and OpenApiDocumentGenerator

  Instead of using OpenApiDocumentGenerator, you can create your own OpenApiBuilder object and add OpenApiOperation to builder object.

  OpenApiBuilder::openapi()
      ->info(
          [
              'title' => 'API',
              'description' => 'API Description',
              'version' => '1.0.0'
          ]
      )
      ->server(
          [
              'url' => '{scheme}://{host}/{base_path}',
              'variables' => [
                  'scheme' => [
                      'enum' => [
                          'http',
                          'https'
                      ],
                      'default' => 'http'
                  ],
                  'host' => [
                      'default' => 'localhost:8000'
                  ],
                  'base_path' => [
                      'default' => 'api'
                  ],
              ]
          ]
      )
      ->component(
          'securitySchemes',
          'bearerAuth',
          [
              'type' => 'http',
              'scheme' => 'bearer',
              'bearerFormat' => 'JWT',
          ]
      )
      ->security(
          [
              'bearerAuth' => []
          ]
      )
      ->operation(
          OpenApiOperation::post('/auth/signup')
              ->tags(['Auth'])
              ->summary('Signup')
              ->description('Signup description')
              ->requestBody(
                  OpenApiRequestBody::create()
                      ->properties(
                          [
                              [
                                  'name' => 'email',
                                  'type' => 'string',
                                  'format' => 'email',
                                  'example' => 'email@example.com',
                                  'description' => 'Email',
                              ],
                              ...
                          ]
                      )
                      ->mediaTypeMultipartFormData()
              )
              ->response(
                  OpenApiResponse::create()
                      ->example(
                          [
                              'data' => [],
                              'message' => null
                          ]
                      )
              )
      )
      ->operation(
          OpenApiOperation::put('/auth/confirm')
              ->tags(['Auth'])
              ->summary('ConfirmSignup')
              ->description('Confirm signup description')
              ->requestBody(
                  OpenApiRequestBody::create()
                      ->properties(
                          [
                              [
                                  'name' => 'email',
                                  'type' => 'string',
                                  'format' => 'email',
                                  'example' => 'email@example.com',
                                  'description' => 'Email',
                              ],
                              [
                                  'name' => 'code',
                                  'example' => 12345,
                              ]
                          ]
                      )
                      ->mediaTypeXWwwFormUrlencoded()
              )
              ->response(
                  OpenApiResponse::create()
                      ->example(
                          [
                              'data' => [],
                              'message' => null
                          ]
                      )
              )
      )
      ->docs();

• Create your own custom route to serve Open API json document and swagger UI