5 ms·

Feel like I'm in college and missed a class lecture - what's the standard for JSON API descriptions and where can I learn more so that I can upgrade my APIs to

Feel like I'm in college and missed a class lecture - what's the standard for JSON API descriptions and where can I learn more so that I can upgrade my APIs to have a usable JSON description?

andrewstuart 12y ago
Swagger
- Maxious 12y ago
  "Swagger is a simple yet powerful representation of your RESTful API." http://swagger.io/ http://swagger.io/
  - deleted 12y ago
    [deleted]
  - wye 12y ago
    What an awful name for such a useful project.
- kevinconroy 12y ago
  Thanks. Here's GitHub link for others interested like me: https://github.com/swagger-api/swagger-spec https://github.com/swagger-api/swagger-spec
- seanp2k2 12y ago
  "Kickin' APIs to the curb unless they look like Mick Jagger" :)
astockwell 12y ago
Not sure if there's really a _standard_, but there are examples of projects[1] and generators[2] that encourage best practices. Presumably if you can document your API as JSON, it should be reasonably well-formed. [1] https://bgentry.io/blog/2014/01/09/auto-generating-a-go-api-client-for-heroku https://bgentry.io/blog/2014/01/09/auto-generating-a-go-api-... [2] https://github.com/pksunkara/alpaca https://github.com/pksunkara/alpaca Update: Here's a link from [1] that may be closer to what you're looking for: http://json-schema.org/ http://json-schema.org/
wye 12y ago
https://stackoverflow.com/questions/12806386/standard-json-api-response-format https://stackoverflow.com/questions/12806386/standard-json-a...
kevinconroy 12y ago
Follow-up: Looks like JSON Schema is emerging as the standard, in part thanks to Swagger and Google adopting it for their APIs. References to Amazon and Heroku doing so as well (not exhaustive list, just what I've found while searching). Helpful links: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md https://github.com/swagger-api/swagger-spec/blob/master/vers... Powerful array of tools to enable wrappers for Go, Scala, Flash, Java, Objc, PHP, Python, Python3, Ruby, Node, and more. https://github.com/swagger-api/swagger-codegen https://github.com/swagger-api/swagger-codegen

Feel like I'm in college and missed a class lecture - what's the standard for JSON API descriptions and where can I learn more so that I can upgrade my APIs to have a usable JSON description?

andrewstuart 12y ago

Swagger

Maxious 12y ago
"Swagger is a simple yet powerful representation of your RESTful API." http://swagger.io/ http://swagger.io/
- deleted 12y ago
  [deleted]
- wye 12y ago
  What an awful name for such a useful project.
kevinconroy 12y ago
Thanks. Here's GitHub link for others interested like me: https://github.com/swagger-api/swagger-spec https://github.com/swagger-api/swagger-spec
seanp2k2 12y ago
"Kickin' APIs to the curb unless they look like Mick Jagger" :)

astockwell 12y ago

Not sure if there's really a _standard_, but there are examples of projects[1] and generators[2] that encourage best practices. Presumably if you can document your API as JSON, it should be reasonably well-formed. [1] https://bgentry.io/blog/2014/01/09/auto-generating-a-go-api-client-for-heroku https://bgentry.io/blog/2014/01/09/auto-generating-a-go-api-... [2] https://github.com/pksunkara/alpaca https://github.com/pksunkara/alpaca Update: Here's a link from [1] that may be closer to what you're looking for: http://json-schema.org/ http://json-schema.org/

wye 12y ago

https://stackoverflow.com/questions/12806386/standard-json-api-response-format https://stackoverflow.com/questions/12806386/standard-json-a...

kevinconroy 12y ago

Follow-up: Looks like JSON Schema is emerging as the standard, in part thanks to Swagger and Google adopting it for their APIs. References to Amazon and Heroku doing so as well (not exhaustive list, just what I've found while searching). Helpful links: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md https://github.com/swagger-api/swagger-spec/blob/master/vers... Powerful array of tools to enable wrappers for Go, Scala, Flash, Java, Objc, PHP, Python, Python3, Ruby, Node, and more. https://github.com/swagger-api/swagger-codegen https://github.com/swagger-api/swagger-codegen