0.0.4 • Published 11 years ago
yours-truly v0.0.4
yours-truly
This is a node.js APIBlueprint formatter for producing HTML documents.
It uses protagonist and ejs to do all the dirty work.
Writing API documentation
For writing API documentation, read up on the APIBlueprint specification.
Here's a small sample:
FORMAT: 1A
HOST: https://api.example.com/v1
# Example API
A simple API example
# Group People
This section describes the People endpoint
## Person [/people/{id}]
Represent a particular Person
+ Parameters
+ id (required, string, `123`) ... The id of the Person.
+ Model (application/json)
```
{"first_name":"Samuel","last_name":"Adams","birthdate":"09-27-1722"}
```
### Retrieve Person [GET]
Return the information for the Person
+ Response 200 (application/json)
[Person][]
Usage
$ ./node_modules/bin/yours-truly INPUT_FILE.md [OUTPUT_FILE.html]
Examples
Output to stdout
1. Create your API markdown file, e.g. `blueprint.md`
1. Run `./node_modules/bin/yours-truly blueprint.md`
1. Pipe the output somewhere
1. Done!
Output to HTML file
1. Create your API markdown file, e.g. `blueprint.md`
1. Run `./node_modules/bin/yours-truly blueprint.md blueprint.html`
1. Done!
Notes
- Trying to view the output HTML file in your browser directly from the filesystem will not display correctly.
Related Projects
If the GO language is more your thing, you might want to check out these projects
github.com/subosita/iglo : Original inspiration of this project
github.com/peterhellberg/hiro : Uses iglo to output HTML to a file