Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ddrv/php-dresscode
PHP OpenAPI schema validator
https://github.com/ddrv/php-dresscode
library openapi php swagger validator
Last synced: 3 days ago
JSON representation
PHP OpenAPI schema validator
- Host: GitHub
- URL: https://github.com/ddrv/php-dresscode
- Owner: ddrv
- License: mit
- Created: 2020-12-30T00:53:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-29T05:22:11.000Z (almost 4 years ago)
- Last Synced: 2023-08-21T09:20:18.821Z (about 1 year ago)
- Topics: library, openapi, php, swagger, validator
- Language: PHP
- Homepage: https://dresscode.ddrv.ru/
- Size: 47.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# DressCode for your data
## Install
```text
composer require ddrv/dresscode
```
## Usage
```php
validate(Action::output(), ['type' => 'string'], 'it is ok');
```
## Check errors
```php
'object',
'properties' => [
'email' => [
'type' => 'string',
'format' => 'email',
],
'login' => [
'type' => 'string',
'minLength' => 5,
'maxLength' => 32,
'pattern' => '^[a-z\-]+$',
],
'birthday' => [
'type' => 'string',
'format' => 'date',
],
],
'required' => ['email', 'login'],
'additionalProperties' => true,
'nullable' => true,
];
$data = [
'email' => 'ivan',
'login' => 'ddrv',
'birthday' => '2020-02-30',
];
try {
$validator->validate(Action::input(), $rule, $data);
} catch (InvalidValueException $e) {
foreach ($e->getErrors() as $error) {
echo $error->getPath() . ': ' . $error->getMessage() . PHP_EOL;
}
}
/*
email: ivan is not a email
login: string size must be between 5 to 32 symbols
birthday: 2020-02-30 is not a date
*/
```
## Defining rules
```php
setEntity('#/entities/email', [
'type' => 'string',
'format' => 'email',
]);
$validator->setEntity('#/entities/login', [
'type' => 'string',
'minLength' => 5,
'maxLength' => 32,
'pattern' => '^[a-z\-]+$',
]);
$validator->setEntity('#/entities/date', [
'type' => 'string',
'format' => 'date',
]);
$rule = [
'type' => 'object',
'properties' => [
'email' => [
'$ref' => '#/entities/email',
],
'login' => [
'$ref' => '#/entities/login',
],
'birthday' => [
'$ref' => '#/entities/date',
],
'password' => [
'type' => 'string',
'minLength' => 8,
'maxLength' => 32,
'writeOnly' => true,
],
],
'required' => ['email', 'login'],
'additionalProperties' => true,
'nullable' => true,
];
$data = [
'email' => '[email protected]',
'login' => 'i-dudarev',
'password' => 'short',
];
$valid = $validator->validate(Action::input(), $rule, $data); // Error password
$valid = $validator->validate(Action::output(), $rule, $data); // No error because password writeOnly
$valid = $validator->validate(Action::input(), ['$ref' => '#/entities/date'], '2020-12-30');
```
## Register your string formats
```php
registerFormat('email', $myEmailFormat);
$rule = [
'type' => 'string',
'format' => 'email',
];
$validator->validate(Action::input(), $rule, '[email protected]');
```
## Strict types
use `Action::input(true)` and `Action::output(true)` for strict type checking.
> **Warning**
>
> do not use it if you are checking data `application/x-www-form-urlencoded`
## Supported types
- [x] boolean
- [x] number
- [x] number (format `float`)
- [x] number (format `double`)
- [x] integer
- [x] integer (format `int32`)
- [x] integer (format `int64`)
- [x] string
- [x] string (format `binary`)
- [x] string (format `byte`)
- [x] string (format `date`)
- [x] string (format `date-time`)
- [x] string (format `email`)
- [x] string (format `hostname`)
- [x] string (format `ip`)
- [x] string (format `ipv4`)
- [x] string (format `ipv6`)
- [x] string (format `uri`)
- [x] string (format `uuid`)
- [x] array
- [x] object
## Supported keywords
### All types
- [x] nullable
- [x] readOnly
- [x] writeOnly
- [x] default (only for object properties)
### Integer and number types
- [x] minimum
- [x] maximum
- [x] exclusiveMinimum
- [x] exclusiveMaximum
- [x] multipleOf
### String type
- [x] pattern
- [x] minLength
- [x] maxLength
- [x] enum
### Array type
- [x] items
- [x] minItems
- [x] maxItems
- [x] uniqueItems
### Object type
- [x] properties
- [x] required
- [x] additionalProperties
- [x] minProperties
- [x] maxProperties
## Support references
- [x] $ref (only after call `setEntity()` method)
## Supported polymorphism
- [x] oneOf
- [x] anyOf
- [x] allOf
- [x] not