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

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

 jpemberthy24 апр. 2012 г., 00:35
Точно, это выглядит потрясающе, но в нем есть куча зависимостей, которых я бы хотел избежать.
 Ismael Abreu24 апр. 2012 г., 00:32
Кажется великолепным, но это также, кажется, требует много работы для настройки

Ответы на вопрос(4)

кой генерации клиентских библиотек с сервера, совместимого с Swaggerhttps://github.com/wordnik/swagger-codegen

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

 jpemberthy24 апр. 2012 г., 15:45
Эй, спасибо за ваш ответ, я думаю, что я дамrapi_doc попытка Он выглядит не так сексуально, как Swagger, но, по крайней мере, его настройка намного проще.
 27 нояб. 2014 г., 17:59
Эта ссылка на rapi_doc не работает. Я нашел его разветвленным в разных местах, напримерgithub.com/phuc/rapi_doc Похоже, что он действительно не поддерживается с 2008 года, хотя
Решение Вопроса

Create an interface for the API by using the swagger-specification. You can do this without using a server, see here.

Verify the interface by using swagger-ui. This allows you to see all the endpoints that you've defined (still, no coding, except for the json files!)

Once you have an interface you want, use swagger-codegen to build a stubbed-out version of your server. There are currently templates for nodejs and scalatra with more on the way. Making a new server generator is simply a matter of creating/modifying some mustache templates.

You can also generate your client with swagger-codegen.

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

 07 сент. 2012 г., 23:05
Доступна поддержка прототипа ruby (обратите внимание! Будут внесены изменения, чтобы сделать больше ruby-ish):github.com/wordnik/swagger-codegen/tree/master/samples/…

apipie за это. Пока что выглядит довольно опрятно.

 jpemberthy28 сент. 2012 г., 18:15
Спасибо, выглядит многообещающе, я учту это для будущего проекта. Уже используя Swagger для приложения, о котором я говорил, когда я отправил вопрос.

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

Ваш ответ на вопрос