API Development - Documentation

Thomas Karam
Apr 1, 2018 · 5 min read

API Blueprint vs Swagger

On to some Documentation

# Data Structures## NewTask+ name: clean the gutters (string, required) — name of the task
- type (enum, required)
— basic|recurring
## Task+ id: 1 (number) — unique identifier of the task
+ Include NewTask
## Create A Task [/tasks]### Create A Task [POST]+ Request (application/json)+ Attributes (NewTask)+ Response 201 (application/json)
+ Attributes (Task)
## Task Search [/tasks/search{?name,type}]

Generating HTML

npm install -g aglio

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade