Zend Expressive Swagger Codegen

With this package you can easily generate Handlers, Models and Routes according to your OpenAPI Specification (OAS) 3.0 config., _(*1)

Requirements

Zend Expressive +3.0

Installation

composer require bradcrumb/ze-swagger-codegen, _(*2)

Usage

Simply place your openapi.json inside of your project root and run the following command:, _(*3)

vendor/bin/swagger codegen, _(*4)

By default the choosen namespace will be App. You can overwrite the namespace with the --namespace option:, _(*5)

vendor/bin/swagger codegen --namespace MyOwnNamespace, _(*6)

The CLI will search for the correct path inside of the composer autoloading. When a namespace is not registered for autoloading it will ask if the namespace folder have to be created and registered in composer.json., _(*7)

Files

The Codegen will generate the following files:, _(*8)

File	Description
`config/autoload/swagger.dependencies.global.php`	Generated dependency and hydrators config
`config/swagger.routes.php`	Swagger routing config
`/Handler/`	Namespace to put all generated Handlers
`/Model/`	Namespace to put all generated Models
`/Hydrator/`	Namespace to put all generated Hydrators

Model Middleware

Every route that requires a Model in its RequestBody has a prepended Middleware: Swagger\Middleware\ModelMiddleware., _(*9)

The Middleware retrieves the RequestBody, hydrates the correct Model and validates the Model., _(*10)

When the RequestBody is invalid it simply returns all errors messages for every property in a 400 response., _(*11)

When the RequestBody is valid the hydrated model will be added as attribute to the request and can be retrieved inside the Handler:, _(*12)

$request->getAttribute('Model');, _(*13)

11/07 2018

dev-master

9999999-dev https://github.com/BradCrumb/ze-swagger-codegen

Zend Expressive Swagger codegen

Sources Download

BSD-3-Clause

library ze-swagger-codegen