Skip to content

Commit fd45e4e

Browse files
authored
Merge pull request #27 from sitegeist/mficzel-patch-2
DOCS: Improve README.md
2 parents b48b34f + 2728e78 commit fd45e4e

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
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.

0 commit comments

Comments
 (0)