Skip to content

README.md

Latest commit

 

History

History
55 lines (40 loc) · 1.82 KB

README.md

File metadata and controls

55 lines (40 loc) · 1.82 KB

API Documentation

Documentation for the Second Street Platform API. Public Link

Contributing

Docs are written (.apib files) in API Blueprint and rendered (.html files) with Aglio. Select HTML files have been copied to a publicly-accessible URL on our FTP server.

Setting Up Aglio

Install Aglio via NPM. You need Node.js installed and you may need to use sudo to install globally:

npm install -g aglio

Helpful Aglio Commands

# Run a live preview server on http://localhost:3000/
aglio -i sending_an_email.apib --theme-template triple -s
# Use three-column layout
aglio -i sending_an_email.apib --theme-template triple -o sending_an_email.html

A list of all aglio commands can be found here.

API Folder structure

Files inside the flows/ directory should be considered partner-publishable API documents. Each .apib file is rendered into a .html file by Aglio, which can be published. The rendered .html files should be checked into the docs/flows folder.

Files inside the endpoints/ directory can be included into flows.

Files inside the docs/ directory are published (and .md files are compiled to .html) to our public Github Pages website. http://secondstreet.github.io/api-docs/

  • docs
    • index.md
    • flows
      • flow_name.html
  • endpoints
    • rest_resource_name
      • endpoint.apib
      • get.apib
      • put.apib
      • post.apib
      • delete.apib
  • flows
    • flow_name.apib

Helpful links