Web API Design, сrafting Interfaces that Developers Love, Mulloy B., 2012

Web API Design, сrafting Interfaces that Developers Love, Mulloy B., 2012.

Introduction.

If you're reading this, chances are that you care about designing Web APIs that developers will love and that you're interested in applying proven design principles and best practices to your Web API. One of the sources for our design thinking is REST. Because REST is an architectural style and not a strict standard, it allows for a lot of flexibly. Because of that flexibility and freedom of structure, there is also a big appetite for design best practices. This e-book is a collection of design practices that we have developed in collaboration with some of the leading API teams around the world, as they craft their API strategy through a design workshop that we provide at Apigee.




Concrete names are better than abstract.

Achieving pure abstraction is sometimes a goal of API architects. However, that abstraction is not always meaningful for developers. Take for example an API that accesses content in various forms - blogs, videos, news articles, and so on. An API that models everything at the highest level of abstraction - as /items or /assets in our example - loses the opportunity to paint a tangible picture for developers to know what they can do with this API. It is more compelling and useful to see the resources listed as blogs, videos, and news articles. The level of abstraction depends on your scenario. You also want to expose a manageable number of resources. Aim for concrete naming and to keep the number of resources between 12 and 24. In summary, an intuitive API uses plural rather than singular nouns, and concrete rather than abstract names.

Table of Contents.

Web API Design - Crafting Interfaces that Developers Love.
Introduction.
Nouns are good; verbs are bad.
Plural nouns and concrete names.
Simplify associations - sweep complexity under the '?'
Handling errors.
Tips for versioning.
Pagination and partial response.
What about responses that don't involve resources?
Supporting multiple formats.
What about attribute names?.
Tips for search.
Consolidate API requests in one sub do main.
Tips for handling exceptional behavior.
Authentication.
Making requests on your API.
Chatty APIs.
Complement with an SDK.
The API Facade Pattern.



Бесплатно скачать электронную книгу в удобном формате, смотреть и читать:
Скачать книгу Web API Design, сrafting Interfaces that Developers Love, Mulloy B., 2012 - fileskachat.com, быстрое и бесплатное скачивание.

Скачать pdf
Ниже можно купить эту книгу по лучшей цене со скидкой с доставкой по всей России.Купить эту книгу


Скачать - pdf - Яндекс.Диск.




Теги: 2012 :: web-дизайн :: Mulloy