Corso's Blog

Posts Tagged ‘web api

10 общих ошибок поставщиков Web API

leave a comment »


Картинка

1. Assuming Everything Will Always Work

«Databases fail, backend dependencies get slow, and/or someone somewhere along the line doesn’t escape output properly. The result? A nasty stack trace at the top of your API payload, which in some cases may even include production database credentials.Solution: Before you launch, kick over some dependency and see what your API does. Developers would rather have a predictable (valid XML/JSON) error message they can code for than a surprise invalid payload.»

Source: Clay Loveless

2. Poor Community Management

«Sometimes we see providers expecting the API alone to attract developers. You need a good service and must communicate to developers what it is you provide. Also, along similar lines, it’s easy to ignore the developer community management, but that communication can make or break your platform. When you get developers’ attention, keep it by being responsive and helpful. Treat them like partners.»
Source: Adam DuVander

Читать далее…

Реклама

Written by Valery Portnyagin

21/08/2010 at 22:50

Опубликовано в Без рубрики

Tagged with

Общие ошибки при проектировании REST Web API

leave a comment »


Картинка Все хотят делать хорошее API в стиле REST да еще с хорошей документацией. Но далеко не у всех это получается. Почему так происходит и как выглядят наиболее частые ошибки допускаемые при разработке, описывается в этойстатье.

Written by Valery Portnyagin

21/08/2010 at 22:00

Опубликовано в Pro API

Tagged with ,

Как правильно писать документацию к Web API

leave a comment »


Картинка

Хорошая статья разъясняющая и описывающая как, зачем и почему необходимо писать хорошую документацию к Web API, собственно как и сам интерфейс.
Небольшой отрывок:»Количество Web APIs растет очень быстро, особенно с растущей популярностью модели Software as a Service. Т.к. Web APIs пока еще относительно новы, то
качество и формат их документации варьируются в широких пределах. Хорошая документация важна для Web APIs, потому что экспериментирование с ними более трудное по сравнению с локальными API. Поскольку Web APIs должны быть языконезависимы, возможно вам придется написать пример кода для различных языков.» Читать далее

Written by Valery Portnyagin

21/08/2010 at 21:09

Опубликовано в Pro API

Tagged with ,