Sinatra build REST API документация

Question

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

Я нашел https://rubygems.org/gems/sinatra-api-docs & https://rubygems.org/gems/sinatra-croon

, но и просто не похоже на работу с моей установки и устарели тоже ..

Другой вариант был двор с некоторыми Синатра плагин, но это не генерировать REST API конкретный макет при создании документов.

У кого-нибудь есть инструменты, о которых они знают?

Вся информация я хочу сослаться на каждый маршрут:

Объект: Группы

Маршрут: POST/создать

Params: Название группы

Выход:

{ 
    "name": "group", 
    "members": [] 
} 

спасибо

Answer 1

Я бы выбрал Apiary.io, он выглядит довольно хорошо спроектированным и использует язык, специфичный для домена Markdown, для описания вашего API. Плюс его бесплатный, пока он еще находится в бета-версии.

Answer 2

Вы попробовали Sinatra Yard? Я использовал его, с некоторыми изменениями в Yard, для создания моих документов API.