https://github.com/four43/cite-api
A JSON-Schema API Documenter
https://github.com/four43/cite-api
Last synced: about 1 year ago
JSON representation
A JSON-Schema API Documenter
- Host: GitHub
- URL: https://github.com/four43/cite-api
- Owner: four43
- License: mit
- Created: 2015-02-27T23:10:34.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-03-04T00:22:30.000Z (over 11 years ago)
- Last Synced: 2025-02-09T10:31:01.248Z (over 1 year ago)
- Language: JavaScript
- Size: 680 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cite-api
A JSON-Schema API Documenter
## Features
* Front End Tech - JSON is just Javascript Objects. Lets make something to document it in Javascript too.
* JSON Schema - Documents what your API is tested to output, not what you hope it outputs.
* Simple - Easy to read documentation. No frills, just nice documentation your developers want.
* Templates - Don't like ours? Make your own with the proven template engine: Handlebars.
Takes in a JSON API Description doc that links to JSON Schema, like below and turns it into simple documentation.
```json
{
"name": "My API",
"description":"My API does neat things in a usable way.",
"resources": [
{
"name": "Alerts",
"description": "Manage alert objects for your user.",
"actions": [
{
"path": "",
"method": "GET",
"description": "Get a list of Alerts",
"responseSchema": "json-schema/alert-list.json"
},
{
"path": ":id",
"method": "GET",
"description": "Get an Alert by an Alert id",
"responseSchema": "json-schema/alert.json"
}
]
}
]
}
```