Подтвердить что ты не робот

Создание и публикация документации API REST на основе Ruby

Каковы классные дети, использующие в настоящее время, чтобы легко анализировать/генерировать/публиковать API REST? Я посмотрел на Swagger, и это выглядит хорошо, но с моей точки зрения это не подходит для Ruby. Может быть, я просто ошибаюсь, и я что-то пропускаю, помощь будет оценена.

Ответ 1

Похоже, у вас еще нет API? Если это так, это тот подход, который я рекомендую.

Создайте интерфейс для API, используя спецификацию swagger. Вы можете сделать это без использования сервера, см. Здесь.
Проверьте интерфейс с помощью swagger-ui. Это позволяет вам видеть все конечные точки, которые вы определили (по-прежнему, без кодирования, кроме json файлов!)
Как только у вас есть необходимый интерфейс, используйте swagger-codegen для создания исправленной версии вашего сервера. В настоящее время существуют шаблоны для nodejs и scalatra с более в пути. Создание нового генератора серверов - это просто вопрос создания/изменения некоторых шаблонов усов.
Вы также можете создать своего клиента с помощью swagger-codegen.

Красота заключается в том, что вы можете создавать интерфейс API с помощью интерфейса. Постройте интерфейсы и заполните пробелы. Сантехника выполнена для вас.

Ответ 2

Мы только начали играть с apipie. До сих пор кажется довольно опрятным.

Ответ 3

Swagger может использоваться с ruby в качестве клиента для автоматического создания клиентских библиотек с сервера, совместимого с Swagger https://github.com/wordnik/swagger-codegen

Если вы используете RoR, я думаю, что вы должны смотреть https://github.com/elc/rapi_doc, но это не так просто.

Ответ 4

Пожалуйста, посмотрите на ApiDoco gem (https://github.com/72pulses/apidoco/) для документации. Он очень прост в настройке и имеет хороший пользовательский интерфейс.