Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ybelenko/openapi-data-mocker-interfaces

Package with OpenApiDataMocker interfaces.
https://github.com/ybelenko/openapi-data-mocker-interfaces

data fake faker interface mock mocker oas oas3 openapi swagger

Last synced: about 1 month ago
JSON representation

Package with OpenApiDataMocker interfaces.

Host: GitHub
URL: https://github.com/ybelenko/openapi-data-mocker-interfaces
Owner: ybelenko
License: mit
Created: 2020-04-10T06:55:37.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-03-19T00:15:15.000Z (almost 3 years ago)
Last Synced: 2024-11-16T17:41:35.274Z (about 2 months ago)
Topics: data, fake, faker, interface, mock, mocker, oas, oas3, openapi, swagger
Language: PHP
Homepage:
Size: 33.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # OpenApi Data Mocker Interfaces

[![Coding Style](https://github.com/ybelenko/openapi-data-mocker-interfaces/actions/workflows/ci.yml/badge.svg)](https://github.com/ybelenko/openapi-data-mocker-interfaces/actions/workflows/ci.yml)

This repository holds interfaces to generate fake data from OpenAPI Specification(OAS3). Note that this is not an implementation.

## Requirements

PHP 7.3 or newer. It could work with older versions, but it's not worth to support _EOL(end of life)_ PHP.

__Important notice! While PHP 8.0 declared in `composer.json` this package hasn't been tested against it.__

## Interfaces

|                                           Class Name                                         | Description |

|----------------------------------------------------------------------------------------------|-------------|

| [OpenAPIServer\Mock\OpenApiModelInterface](src/Mock/OpenApiModelInterface.php)               | All referenced components must implement that interface. |

| [OpenAPIServer\Mock\OpenApiDataMockerInterface](src/Mock/OpenApiDataMockerInterface.php)     | Basic data generator. Can mock scalar data types. |

| [OpenAPIServer\Mock\OpenApiServerMockerInterface](src/Mock/OpenApiServerMockerInterface.php) | Enhanced data generator. Can mock server request and server response. |

| [OpenAPIServer\Mock\Exceptions\OpenApiDataMockerException](src/Mock/Exceptions/OpenApiDataMockerException.php) | Implementation should throw exceptions inherited from that class. |

### `OpenAPIServer\Mock\OpenApiDataMockerInterface` Constants

[OpenAPISpecification - Data Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#dataTypes)

| Constant Name           | Referenced OAS type | Referenced OAS format |

|:-----------------------:|:-------------------:|:---------------------:|

| `DATA_TYPE_INTEGER`     |     `integer`       |                       |

| `DATA_TYPE_NUMBER`      |     `number`        |                       |

| `DATA_TYPE_STRING`      |     `string`        |                       |

| `DATA_TYPE_BOOLEAN`     |     `boolean`       |                       |

| `DATA_TYPE_ARRAY`       |     `array`         |                       |

| `DATA_TYPE_OBJECT`      |     `object`        |                       |

| `DATA_FORMAT_INT32`     |                     |        `int32`        |

| `DATA_FORMAT_INT64`     |                     |        `int64`        |

| `DATA_FORMAT_FLOAT`     |                     |        `float`        |

| `DATA_FORMAT_DOUBLE`    |                     |        `double`       |

| `DATA_FORMAT_BYTE`      |                     |         `byte`        |

| `DATA_FORMAT_BINARY`    |                     |        `binary`       |

| `DATA_FORMAT_DATE`      |                     |         `date`        |

| `DATA_FORMAT_DATE_TIME` |                     |       `date-time`     |

| `DATA_FORMAT_PASSWORD`  |                     |       `password`      |

| `DATA_FORMAT_EMAIL`     |                     |                       |

| `DATA_FORMAT_UUID`      |                     |                       |

### `OpenAPIServer\Mock\OpenApiDataMockerInterface` Methods

|                    Method Name                      |                    Description                  | Return Type |

|-----------------------------------------------------|-------------------------------------------------|:-----------:|

| `mockData(string $dataType, ?string $dataFormat = null, ?array $options = [])`| Mocks OpenApi Data.                             |   `mixed`   |

| `mockInteger(?string $dataFormat = null, ?float $minimum = null, ?float $maximum = null, ?bool $exclusiveMinimum = false, ?bool $exclusiveMaximum = false): int` | Shortcut to mock integer type. Equivalent to `mockData(DATA_TYPE_INTEGER)`\*. | `int`  |

| `mockNumber($dataFormat = null, $minimum = null, $maximum = null, $exclusiveMinimum = false, $exclusiveMaximum = false): float` | Shortcut to mock number type. Equivalent to `mockData(DATA_TYPE_NUMBER)`\*. | `float` |

| `mockString(?string $dataFormat = null, ?int $minLength = 0, ?int $maxLength = null, ?array $enum = null, ?string $pattern = null): string` | Shortcut to mock string type. Equivalent to `mockData(DATA_TYPE_STRING)`\*. | `string` |

| `mockBoolean(): bool` | Shortcut to mock boolean type. Equivalent to `mockData(DATA_TYPE_BOOLEAN)`\* | `bool` |

| `mockArray(array $items, ?int $minItems = 0, ?int $maxItems = null, ?bool $uniqueItems = false): array` | Shortcut to mock array type. `Equivalent to mockData(DATA_TYPE_ARRAY)`\*. | `array` |

| `mockObject(array $properties, ?int $minProperties = 0, ?int $maxProperties = null, $additionalProperties = null, ?array $required = null): object` | Shortcut to mock object type. Equivalent to `mockData(DATA_TYPE_OBJECT)`\*. | `object` |

| `mockSchemaObject(array $schema)` | Mocks OpenApi Schema Object. | `mixed` |

\* constant class is omitted, so `mockData(DATA_TYPE_INTEGER)` means `mockData(\OpenAPIServer\Mock\OpenApiDataMockerInterface\DATA_TYPE_INTEGER)`.

### `OpenAPIServer\Mock\OpenApiModelInterface` Methods

|                    Method Name                      |                                       Description                                    | Return Type |

|-----------------------------------------------------|--------------------------------------------------------------------------------------|:-----------:|

| static `getOpenApiSchema(): array`                         | Gets OAS 3.0 schema mapped to current class.                                         |   `array`   |

| static `createFromData($data): OpenApiModelInterface`                      | Creates new instance from provided data.                                             |   `OpenAPIServer\Mock\OpenApiModelInterface`   |

| `jsonSerialize()` inherited from `JsonSerializable` | Serializes the object to a value that can be serialized natively by `json_encode()`. |   `mixed`   |

### `OpenAPIServer\Mock\OpenApiServerMockerInterface` Methods

Same methods as `OpenAPIServer\Mock\OpenApiDataMockerInterface` + following methods:

|           Method Name           |         Description          |               Return Type                 |

|---------------------------------|------------------------------|:-----------------------------------------:|

| `setServer(?string $url = null, ?array $variables = null): void`   | Sets base url for mocked requests.  | `void` |

| `mockRequest(string $path, string $method, ?array $parameters = null, ?array $requestBody = null, ?array $security = null, ?array $callbacks = null): ServerRequestInterface`   | Mocks PSR-7 server request.  | `Psr\Http\Message\ServerRequestInterface` |

| `mockResponse(string $httpStatusCode = '200', ?array $headers = null, ?string $contentMediaType = null, ?array $contentSchema = null): ResponseInterface` | Mocks PSR-7 server response. | `Psr\Http\Message\ResponseInterface`      |

### `OpenAPIServer\Mock\Exceptions\OpenApiDataMockerException`

This class makes possible to catch exceptions related to mocking feature only. It's highly encouraged not to throw builtin PHP exceptions like `Exception`, `InvalidArgumentException` etc. Use this class or extend it with your own exceptions to fit your needs.

## Related Packages

* [Openapi Data Mocker](https://github.com/ybelenko/openapi-data-mocker) - first implementation of OAS3 fake data generator.

* [Openapi Data Mocker Server Middleware](https://github.com/ybelenko/openapi-data-mocker-server-middleware) - PSR-15 HTTP server middleware.

## Copyright

While author of this package is top contributor to OpenAPI-Generator project he's not member of OpenAPI Initiative (OAI).