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
Feb 25, 2013 @ 18: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.

tagged: zendframework2 rest api tutorial series documentation options enduser

Link:

ATK Blog:
PHP5 adoption - a summary
Dec 20, 2006 @ 16:44:17

On the ATK blog today, Ivo Jansch has posted a great overview of the current state of PHP5 adoption and the varying perspectives on it.

Maybe we can derive some lessons from this for the future, how to handle the release of PHP6 for example; which parties we should target, and how we should approach the release. In any case, here is the result of my analysis. If I left something out, feel free to provide additional comments.

He takes a look at things from five different perspectives:

  • Developer (distributable software)
  • Developer (tailor made software)
  • Hosting Provider
  • OS Distributions
  • End User
For each, he touches on who they are, why they should make the move up to PHP5, what might be keeping them from it and a solution that would help them upgrade with the least amount of problems.

tagged: php5 adoption summary developer hosting provider enduser php5 adoption summary developer hosting provider enduser

Link:

ATK Blog:
PHP5 adoption - a summary
Dec 20, 2006 @ 16:44:17

On the ATK blog today, Ivo Jansch has posted a great overview of the current state of PHP5 adoption and the varying perspectives on it.

Maybe we can derive some lessons from this for the future, how to handle the release of PHP6 for example; which parties we should target, and how we should approach the release. In any case, here is the result of my analysis. If I left something out, feel free to provide additional comments.

He takes a look at things from five different perspectives:

  • Developer (distributable software)
  • Developer (tailor made software)
  • Hosting Provider
  • OS Distributions
  • End User
For each, he touches on who they are, why they should make the move up to PHP5, what might be keeping them from it and a solution that would help them upgrade with the least amount of problems.

tagged: php5 adoption summary developer hosting provider enduser php5 adoption summary developer hosting provider enduser

Link:


Trending Topics: