jsonary-js / jsonary

Quickly assemble clients for JSON-based APIs (powered by JSON Schema)
http://jsonary.com/
MIT License
122 stars 14 forks source link

Documentation #12

Open geraintluff opened 12 years ago

geraintluff commented 12 years ago

Easiest way is probably a custom JSON format:

Set up quick-and-dirty editing API for local use.

geraintluff commented 12 years ago

You also need documentation for the plugins.

Perhaps /api/ and /api/plugins/render/?

geraintluff commented 12 years ago

Current documentation is uncategorised.

How about making "category" pages, that group methods by purpose, and embed particular method definitions like data.json#/methods/pointerPath?

geraintluff commented 12 years ago

API documentation format needs something like extends/allOf.

Format could actually extend JSON Schema. Have a oneOf that checks for presence of arguments or results to apply "function definition" schema?

geraintluff commented 12 years ago

Needs theme-specific page (page documenting all AJAX methods, page documenting all data manipulation methods).

Separate docs for in-browser renderer.