Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 1.35 KB

README.md

File metadata and controls

32 lines (18 loc) · 1.35 KB

Bootstrap API Docs

This little library enables you to create sexy API documentation using a very simple XML syntax and Twitter's incredible Bootstrap library.

Getting Started

  • Download the library or clone the repository
  • Copy the contents to your webserver
  • Open up index.php in your browser
    • The page will render the output of the default config.xml file
  • Review the simple config.xml file for instructions on how to structure your API

Exporting

  • You can export your API as a ZIP file by simple removing the preview = "true" attribute in the beginning the config.xml file. Running index.php after this will prompt your browser to download a ZIP file containing everything you need to deploy.

Questions, Suggestions & Contributions

All welcome!

Web site: http://soapbox.io

Twitter: http://twitter.com/soapboxio

You can contact us at soapbox.io

About us

soapbox.io provides professional SOA services with PHP. We create solid, lightweight REST implementations build with Doctrine ORM, Aerial and Slim.

Contact us