The Web API Design Guidelines for Happy Developers
Last updated on 2016-04-19
About the Book
When developing a modern Web Application, it’s increasingly likely that you, as a developer, will need to use an API: be it a social network plugin API, an e-commerce checkout API, a Captcha, a Web Analytics suite. In today’s Web development APIs are ubiquitous.
But as you wandered through dozens of different APIs, you’ve certainly found out already that they’re not all born equal: for each API that is well thought, well documented, easy to understand and fun to use, there are dozens that are obscure and inconsistent, error-prone and tedious.
The goal of this ebook is to provide a set of guidelines through key points/tips on how to design Web APIs that are, at the same time: nice and sound, fun to use and logically consistent. We don’t like to call them REST, as we don’t want to introduce unneeded constraints in our guidelines. We prefer to call them Pragmatic Web APIs.
- About the Authors
- Resource Names and URL Design
- API Base URL and Versioning
- Create with POST
- Read with GET
- Update with PUT
- Delete with… DELETE
- Limitations of HTTP PUT e DELETE
- Rate Limiting
- Errors and Statuses in Responses
- Dates and Time
- Partial Responses
- Authentication and Authorization
- Browser Same Origin Policy
- Software Development Kits
- And… one more tip
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms...