ybelenko / openapi-data-mocker Goto Github PK

Package accepts deserialized parts of OAS spec as arguments right now. However, it might be much more convenient to specify path to complete OAS spec file and use only operation/model names to mock data.

As a conclusion, package should:

1. Parse yaml or json OAS spec file and store result in static variable.
2. Provide additional methods like:
   • mockModelFromSpec(string $modelName)
   • mockOperationFromSpec(string $operationId)
   • mockResponseFromSpec(string $operationId, string $responseStatusCode = 'default', string $mediaType = null).

I guess there might be issues with specs divided into many referenced files, but it's not common case and can be fixed afterwards.

It would be great to use fakerphp/faker as fake data provider because:

1. It's well known stable solution with many features.
2. It supports seed to generate the same values in unit tests.
3. It generates real human examples in comparison to this package.
4. It can generate data for different locales.

The only disadvantage of fzaninotto/faker is library size(3.5MB). That's why I'm going to add it as suggest package, not required.

I submit this issue just to show what I'm working on right now!

Ref: OpenAPI Specification 3.1.0 - Composition and Inheritance (Polymorphism)

Current Mocker ignores allOf property, so it's not possible to use composition in models.

Mocker should merge components joined by allOf refs.

I'm creating first implementation of OpenAPIServer\Mock\OpenApiServerMockerInterface

This class is crucial for server unit tests.
For example, when I need to test createUser API operation I need to mock valid Psr\Http\Message\ServerRequestInterface instance based on OAS3.0 Path Item Object and pass it to server handler. That's what OpenAPIServer\Mock\OpenApiServerMockerInterface::mockRequest method has been created for:

    public function mockRequest(
        string $path,
        string $method,
        ?array $parameters = null,
        ?array $requestBody = null,
        ?array $security = null,
        ?array $callbacks = null
    ): ServerRequestInterface;

I submit this issue just to show what I'm working on right now!