пятница, 1 февраля 2013 г.

apiary.io


Хочу всем программистам посоветовать сервис для описания API под названием
apiary.io

Это как GitHub, только не для исходников, а для очень удобного описания, тестирования, и документирования любого API.

Для чего это нужно?
Например вы создаете сайт и хотите сделать к нему API, например для мобильного приложения. Встает логичный вопрос - где и как вы будете хранить описание и документацию по этому API. Более того, если этим API будете пользоваться не только вы, то желательно сразу выделить отдельный сервер для тестирования, который не будет падать в то время, как ваш проект стремительно развивается в альфа версии (те кто знают, те поймут).

И в этот момент apiary (что значит пасека или набор ульев), может невероятно удобно решить все описанные проблемы. В одном документе в режиме разметки MarkDown вы за 5 минут описываете ваше API с примерами запросов и ответов и автоматически получаете просто невероятное кол-во функций:

  1. Ваше API очень красиво выглядит и вы можете на него ссылаться
  2. Пользователи сайта могут получить сразу сгенерированный код для вызова API на следующих языках (curl, javascript, node.js, python, php, ruby)
  3. Пользователи сайта могут писать комментарии к любому методу API
  4. Пользователи могут вызвать любой из методов прямо из браузера
  5. И самое главное - для вашего API автоматически бесплатно создается надежный сервер для тестирования на самом apiary!!! И в нем есть очень удобный дебагер, который показывает, кто и когда посылал запросы и какие были ответы!

Можно создавать приватные "репозитории". Система превосходит все возможные ожидания.

Я описал далеко не все функции, там есть интеграция с гитхабом, еще есть проверка, что ваш API не устарел и работает в соответствии с описанием и т.д.

Я слышал про нее пол года назад, но до сих пор не использовал.

Вот очень маленький API пример для одного из моих проектов:
http://docs.linkentools.apiary.io/