File tree Expand file tree Collapse file tree 1 file changed +16
-1
lines changed
Expand file tree Collapse file tree 1 file changed +16
-1
lines changed Original file line number Diff line number Diff line change 11# Sitegeist.SchemeOnYou
2+ ## API Documentation that is always complete, accurate and up to date. For humans and machines
23
3- Build APIs with autogenerated OpenApi-Specs by using scalar Types, data transfer objects (DTOs) and collections of DTOs.
4+ SchemOnYou makes the implementation of REST/JSON APIs simple and easy. It enforces strong conventions and
5+ modern type safe php code for data transfer objects (DTOs). SchemOnYou generates OpenApi-Specs directy
6+ from the controller code wich ensures that the documentation is always complete, up to date and accurate.
7+
8+ Since OpenApi-Specs are human and machine readable SchemeOnYou allows to integrate with tools like swagger-ui
9+ but also with code generators that allow to generate type safe client code to consume the apis.
10+
11+ This allows type safe and static analyzable code from the backend through JSON/Rest apis to the frontend and back.
12+ For faster development pace while maintaining high quality and end to end type safety.
413
514## TLDR:
615
16+ #### Sitegeist.SchemeOnYou provides:
17+ - A strong convention for PHP DataTransferObjects based on modern PHP code
18+ - Serializers and deserializers for those DTOs
19+ - A base class for REST/JSON endpoint controllers where each endpoint recieves and returns DTOs
20+ - A generator for OpenAPI schemas describing the DTOs and endpoints
21+
722#### Differences:
823- Controllers extend ` Sitegeist\SchemeOnYou\Application\OpenApiController `
924- ControllerActions must accept and return supported types.
You can’t perform that action at this time.
0 commit comments