mirror of https://github.com/jlengrand/openapi-generator.git synced 2026-05-16 15:54:31 +00:00

Files

Dec12 | Fujigon bb056ccf3d [General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly (#1200 )

* fix InlineModelResolver's logis and use openapi-generator's InlineModelResolver, so that nested "required" works correctly

* add "required" to nested model schema

* update ensure-up-to-date to include openapi v3's jaxrs

* change test required field

* fix sample shell script, hide timestamp

* fix NPE

* move test case to petstore-with-fake-endpoints-models-for-testing.yaml

* fix jaxrs-jersey (oas3) example generate shell script to use petstore-with-fake-endpoints-models-for-testing.yaml

* add default value

* re-generate samples

2018-10-23 16:51:55 +08:00

.openapi-generator

Prepare 3.3.2 snapshot version (#1249 )

2018-10-16 10:53:12 +08:00

application

[Golang][client] fix for schema definition name file (#433 )

2018-07-05 20:32:24 +08:00

public

[PHP] Adjust the names (script, sample folder, generator) to lang option (#159 )

2018-05-28 13:49:47 +08:00

src/App

[General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly (#1200 )

2018-10-23 16:51:55 +08:00

.gitignore

[PHP] Add gitignore to AbstractPhpCodegen (#765 )

2018-08-20 12:16:01 +08:00

.openapi-generator-ignore

[PHP] Adjust the names (script, sample folder, generator) to lang option (#159 )

2018-05-28 13:49:47 +08:00

composer.json

[PHP] Adjust the names (script, sample folder, generator) to lang option (#159 )

2018-05-28 13:49:47 +08:00

README.md

[PHP] Adjust the names (script, sample folder, generator) to lang option (#159 )

2018-05-28 13:49:47 +08:00

README.md

OpenAPI generated server

Generated by the OpenAPI Generator project.

Overview

This server stub aims to provide light, yet comprehensive structure for your API project using:

PHP: 5.6 or 7.*
Zend Expressive: 2.1
Path Handler: 0.3

How to use

All you have to do to start development is:

install dependencies via Composer
create cache folder: mkdir -p ./data/cache/ZendCache (you will need it later for configuration and metadata caches - check comments in ./application/config.yml)
start PHP development server: php -S 0.0.0.0:8080 -t ./public (or any other SAPI you prefer, just make sure that you configure webroot to ./public and rewrites to ./public/index.php)

After that you should be able to call all methods from your API spec. Most of the negative scenarios should be handled:

404 Not found for unknown routes
406 Not acceptable for invalid Accept header
415 Unsupported media type for invalid Content-Type header
400 Malformed JSON for unparsable JSON body
422 Unprocessable entity for parsable JSON body that fails validation

But for obvious reason you will not get any 200 OK, only 500 Not implemented. So your next steps are:

check all TODOs left in the stub code where generator was not smart enough and could not guarantee correct implementation
implement your API security mechanism (either special attribute or separate middleware) - generator does not do anything about it yet
implement your handlers - the most tricky part :)

Enjoy!

Hopefully this stub will reduce the amount of boilerplate code you have to write manually. If you have any suggestions or questions about ze-ph generator, feel free to create issue either in Path Handler repository or in OpenAPI Generator repository.