Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Add support to JSON:API as a schema type #9165

Open
swilgosz opened this issue Oct 14, 2020 · 1 comment
Open

Feature request: Add support to JSON:API as a schema type #9165

swilgosz opened this issue Oct 14, 2020 · 1 comment

Comments

@swilgosz
Copy link

Is your feature request related to a problem? Please describe.

We are developing our API collections using JSON:API standard and we would love to create a new API in Postman for finished Services.

However, currently, we can only choose OpenAPI, RAML or GraphQL as schema types. There is no JSON:API nor even the custom one.

image

Describe the solution you'd like

Ideally, add an option to choose JSON:API standard as a schema type

Describe alternatives you've considered

Delivering the custom option possibly could work.

Additional context

Basically, we cannot use the whole APIs feature with our chosen API schema.

image

@n2ygk
Copy link

n2ygk commented Nov 5, 2020

JSON:API can be described by OpenAPI 3.0 -- well, with one bug fix in the OpenAPI spec which is coming in the 3.1 release having to do with JSON:API requiring the DELETE method to have a request body.

For example, Django-REST-Framework-JSON-API release 4.0 now has an initial implementation of automatic JSON:API schema generation based on the serializer definitions. Please use (improve!) the components boilerplate from that code as a start!

I've successfully imported an OpenAPI 3.0 spec generated by this code into Postman. There's one Postman bug (#9053) that appears to have been closed in error having to do with representing deepObject.

I hope this helps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants