search

smizell / restfuljson

RESTful JSON Specification
14 stars 1 forks source link

Provide ready-made Markdown to copy-paste #19

Open honzajavorek opened 6 years ago

honzajavorek commented 6 years ago

This could be a little step to ease adoption, although I'm not sure how suitable it is for a "spec" document. Both API Blueprint and OpenAPI Spec support Markdown, so this could be useful for most API description format users. Also many documentations not based on API description formats could be written in Markdown.

smizell commented 6 years ago

Thanks for this. I think having the same thing in there twice is probably not necessary. I think we could just convert what I have to use your Markdown (which makes sense) and then replace the line before it with:

API providers SHOULD consider adding something like the note below to their documentation to describe how links are used.