News Feed
Sections




News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

Matthew Weier O'Phinney:
RESTful APIs with ZF2, Part 3
February 25, 2013 @ 12:21:30

Matthew Weier O'Phinney has posted the third part of his series about making RESTful APIs with Zend Framework 2 (parts one and two). In this latest part of the series, he talks more about documenting the API and what commands can be executed.

In this post, I'll be covering documenting your API -- techniques you can use to indicate what HTTP operations are allowed, as well as convey the full documentation on what endpoints are available, what they accept, and what you can expect them to return. [...] hy Document? If you're asking this question, you've either never consumed software, or your software is perfect and self-documenting. I frankly don't believe either one.

He covers a few reasons why you should document your API and where he thinks it should live to be the most useful. He includes a few different ideas and two things he definitely thinks should exist for your API - the use of OPTIONS and end-user documentation. The first is a HTTP header (ZF2 code example included) that tells the API consumer what they can do with an endpoint. The second type is more useful for the human reader, giving them a better overall perspective on what the API can do - still served through the API but in a bit more understandable format.

0 comments voice your opinion now!
zendframework2 rest api tutorial series documentation options enduser


blog comments powered by Disqus

Similar Posts

Igor Wiedler: Binary parsing with PHP

Matthias Noback: Symfony2: How to create framework independent controllers?

Alexy Kovyrin\'s Blog: Nginx With PHP As FastCGI Howto

php|architect Blog: WordPress 404 Plugin built on Bing Wrapper

DevShed: MySQL Table Prefix Changer Tool in PHP


Community Events





Don't see your event here?
Let us know!


podcast interview conference release laravel library series composer version community artisanfiles introduction list voicesoftheelephpant symfony language security framework tool opinion

All content copyright, 2014 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework