json-api does not appear to be supported

Using swagger-ui 3.0.10 (currently use dev HEAD) I’m not able to get json-api to work correctly.

The request and response content types are displayed as application/vnd.api+json which is what my server is set to, so that’s good.

However, the Example Value is structured as a JSON object instead of JSON-API. A simple fix for this would be to take the current example value and put it into a data object:

data: {
   attributes: {
      // what is currently showing up as the Example Value.
   }
}

A related issue is that “Try it out” does not work, because its not sending properly formatted json-api data.

There are several javascript json-api implementations, include one in redux. http://jsonapi.org/implementations/#client-libraries-javascript

[cemsbr]

I’m not sure whether my problem is included in your discussion. If I change application/json to application/vnd.api+json (JSON API content type), the example is not rendered anymore. Could swagger-ui treat vnd.api+json exactly like json and render the example the same way?

[adhamhf]

Thanks all. I appreciate your time. I don’t think I’ve been able to convey the advantages of my proposal correctly, or maybe even the proposal itself. The downsides of text based communication.