Download the PHP package apie/schema-generator without Composer
On this page you can find all versions of the php package apie/schema-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download apie/schema-generator
More information about apie/schema-generator
Files in apie/schema-generator
Package schema-generator
Short Description Composer package of the apie library: schema generator
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package schema-generator
schema-generator
This package is part of the Apie library. The code is maintained in a monorepo, so PR's need to be sent to the monorepo
Documentation
The schema generator creates a JSON Schema from an object with typehints. It supports entities, lists, hashmaps, value objects and DTO made for Apie. It returns objects made with the library cebe/php-openapi.
This library does not generate an entire OpenAPI schema, but instead it just creates the JSON schema section of all the objects.
Standard usage
In general you make multiple schemas for multiple objects with references. Because of that we basically create a Components section
Code example:
DTO's
DTO's will be mapped as objects and all fields required unless it has the Optional attribute or a default value.
Will Result in this schema:
Enums
Enums will be mapped with type string or int and all the values in the enum property.
Backed enums will use the value of the enum. Enums without values use the names and are always mapped as strings.
Entities
Entities will be mapped by reading the constructor arguments and all the methods starting with set or with.
Any constructor argument is considered a required option, unless it has a default value.
For all methods starting with set or with it expects the last argument to be the type needed. Other arguments are considered for contextual reasons (like being authenticated or the current locale).
Value Objects
It tries to figure out what value objects the object is. For example if it uses one of the standard traits it will map those to objects or strings or read the toNative() return typehint.
- If it implements HasRegexValueObjectInterface, pattern is filled in.
- If it implements StringValueObjectInterface, type is filled in as string and the format is the name of the class without namespace.
- If the class uses the CompositeValueObject trait, it will be mapped as an object.
Complete customization
You can add SchemaMethod attribute to a class and add a static method class to specify an openAPI schema for a class.
The method can return an instance of cebe\Openapi\Schema (you require cebe/php-openapi") or return an array of the schema.
All versions of schema-generator with dependencies
apie/core Version self.version
apie/dateformat-to-regex Version self.version
devizzent/cebe-php-openapi Version ^1.1.2