The Slim Framework support forum has moved to http://discourse.slimframework.com. This Tender forum is no longer maintained or monitored.

How do you make an API documentation.

stil's Avatar

stil

27 Jan, 2012 01:01 PM

I wonder, how do you make documentation for yours API.
I think the best way is writing doc blocks for every route:
api/routes/market.php

/*
 * @link /api/v3/market/:country
 * @param :country ISO 3166-1 code of country
 */

We can parse it and than output formatted documentation.
What's your way doing it?

  1. Andrew Smith closed this discussion on 01 Aug, 2012 12:42 PM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac