В настоящее время я работаю над созданием веб-сервиса RESTful в Rails. Я ищу некоторые способы создания хорошей документации в моем Rails-сервисе Rails. Я нашел несколько способов сделать это:
Может ли кто-нибудь дать какие-либо рекомендации?
Если вы имеете в виду, что вы хотите создать документацию для каждого URI, который ваши маршруты сделали доступным, вы не будете следовать ограничениям REST. API RESTful может иметь только ваш URI точки входа. Описания типов ваших носителей показывают, как найти другие ресурсы через URI, встроенные в гипертекст ваших ответов. Итак, нет автоматизированного способа сделать это.
Посмотрите Sun Cloud API для отличного примера.
api_taster: Rails-специфический и еще не проверенный, но выглядит очень красиво и не требует много работы/ввода: https://github.com/fredwu/api_taster#readme
или просмотрите мою статью для других решений.
Попробуйте этот камень, он очень полный: https://github.com/Apipie/apipie-rails
Вы считаете, что вам не нравятся выходные данные по умолчанию этих параметров?
Если да, взгляните на hanna или sdoc, который "украсит" ваш rdoc. Приветствия.