Corso's Blog

Posts Tagged ‘REST

Общие ошибки при проектировании 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 ,