ubirak / symfony-json-rest-api Goto Github PK

We should allow people to use this stuff with a better DX.

• Bundle ?
• Flex ?

Copy/Paste is just a problem if we add/modify stuff

Hi,

I'm using Swagger to define Schema Objects which are based on the JSON Schema Specification Draft 4.

I have a standalone example that you can find here:
https://gist.github.com/jeremyb/a0419ad9d5501fb602f052169112166f

I'm curious to know if you might be interested to make symfony-json-rest-api works with Swagger (not only with separate JSON Schema files).

Currently, I see some issues with the PayloadValidator class (especially with $jsonSchemaFilename: file_exists and realpath calls).

Also, we probably need to update JsonSchemaTools to allow the creation from a SchemaStorage?

Do you have some ideas about how to handle that? I'm available to contribute in the next days/weeks :)

• We should illustrate with better example each features.
• We should compare to api-platform to get why this lib exists

Description

Steps to reproduce the issue:

1. Have a Symfony controller action that return this kind of response:

return new JsonResponse(['key' => $request->get('key')]);

2. then request this action like that:

# We don't set any Accept nor Content-Type header
curl -d '{"key": "value"} http://domain.tld/path 

Describe the results you received:

HTTP/1.1 200 OK

{"key": null}

Describe the results you expected:

HTTP/1.1 406 Not Acceptable

Note: Here we consider that we implement HTTP content negociation the right way so the client must provide a Content-Type header.

From where to start

The actual part of JsonBodyListener incrimined code is:

https://github.com/rezzza/symfony-json-rest-api/blob/67639f9383eb4637f6ea56eed136af5373282428/src/JsonBodyListener.php#L34-L40

Other source(s) to watch for inspiration

FOSRestBundle FormatListener.php#L58-L75:

            $format = $request->getRequestFormat(null);
            if (null === $format) {
                $accept = $this->formatNegotiator->getBest('');
                if (null !== $accept && 0.0 < $accept->getQuality()) {
                    $format = $request->getFormat($accept->getValue());
                    if (null !== $format) {
                        $request->attributes->set('media_type', $accept->getValue());
                    }
                }
            }

            if (null === $format) {
                if ($event->getRequestType() === HttpKernelInterface::MASTER_REQUEST) {
                    throw new NotAcceptableHttpException('No matching accepted Response format could be determined');
                }

                return;
            }