Corso's Blog

Как правильно писать документацию к 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 в 21:09

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

Tagged with ,

Добавить комментарий

Заполните поля или щелкните по значку, чтобы оставить свой комментарий:

Логотип WordPress.com

Для комментария используется ваша учётная запись WordPress.com. Выход / Изменить )

Фотография Twitter

Для комментария используется ваша учётная запись Twitter. Выход / Изменить )

Фотография Facebook

Для комментария используется ваша учётная запись Facebook. Выход / Изменить )

Google+ photo

Для комментария используется ваша учётная запись Google+. Выход / Изменить )

Connecting to %s

%d такие блоггеры, как: