Alternative displays to Swagger UI?

[Tom Johnson]

Are there any alternative displays for Swagger UI that don't involve Apiary, Apigee, or other API management platforms? 

I want to use Swagger UI, but the API I'm documenting has an endpoint that passes a REALLY LONG JSON object in the request body. The JSON is 200 lines long, and I feel like Swagger UI's display isn't really ideal when it comes to describing the JSON passed in request bodies. When you flip to the Model view, all the nested objects can expanded out and weirdly referenced. 

RAML's display for JSON isn't really any better, and is in some ways more confusing.

Are there alternative outputs that might handle descriptions of JSON in request body parameters a little better?

[tony tam]

There are many, here’s one really good one:

https://github.com/jensoleg/swagger-ui

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Tom Johnson]

Great! Thanks for pointing me to that one. I like it and will play around with it. I didn't realize that Apiary's general display was pushed out as an open source project.

---------------------

blog: idratherbewriting.com
twitter: tomjohnson

email: tomjohn...@gmail.com

cell: 408-540-8562

--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/uypw-ozjlx8/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

[Tom Johnson]

Thanks for pointing me to this responsive swagger UI theme (https://github.com/jensoleg/swagger-ui).  However, it doesn't work very well. It isn't able to parse the YAML (just JSON), and the only swagger spec I could get it to parse was a simple one. When I tried to feed it a more complex structure (which was valid), it could display anything.

Additionally, the real need I have is for a better display of JSON in a request body. Swagger UI's inability to show nested JSON objects (in the Model view) has made the delivery team at my work reject Swagger as an option for the documentation.

You said there are lots of alternatives to Swagger UI as a display mode for the swagger spec. I need a display that will show nested JSON objects, similar to how they are represented by the Swagger editor (with expand/collapse triangles). Is there anything that can handle this? The request body for one of my endpoints is literally thousands of lines long.

Also, if you could point me to some of these other Swagger UI you while, it would really help.

Thanks,

Tom

On Tuesday, January 26, 2016 at 2:40:02 PM UTC-8, Tom Johnson wrote:

Great! Thanks for pointing me to that one. I like it and will play around with it. I didn't realize that Apiary's general display was pushed out as an open source project.

On Tue, Jan 26, 2016 at 2:37 PM, tony tam  wrote:

There are many, here’s one really good one:

https://github.com/jensoleg/swagger-ui

On Jan 26, 2016, at 2:35 PM, Tom Johnsonwrote:

[Tobias Strebitzer]

Probably a bit late, but here's one I've created after feeling the same pain as you did:

https://groups.google.com/forum/?hl=en#!topic/swagger-swaggersocket/jp1xQgxJmJE

It's still WIP though, and might not yet deliver all you need.

Cheers,

Toby

[andrew....@shopify.com]

Hi Tom,

I am using Redoc currently, and I find it is particularly good at representing complex JSON objects

http://swagger.io/redoc-openapi-powered-documentation/

Let me know what you think