RESTful APIを文書化するには？

Question

私はRoRを初めて使用しています。

Django REST SwaggerのようなRESTful APIを文書化する方法はありますか？

次に、apipie-railsが私のAPIを文書化しています。

しかし、私はSpreeと統合しようとすると、私は次のエラーを得た：

Unable to autoload constant BaseControllerDecorator, expected /${PATH}/base_controller_decorator.rb to define it. 

base_controller_decorator.rb

Spree::Api::BaseController.class_eval do 

    # Some overrided functions 

end 

私はlibに/ apipie/application.rbに次のコードを見つけました：

def load_controller_from_file(controller_file) 
    controller_class_name = controller_file.gsub(/\A.*\/app\/controllers\//,"").gsub(/\.\w*\Z/,"").camelize 
    controller_class_name.constantize 
end 

コントローラがデコレータファイルでインスタンス化されているようですどのようにそれを働かせる？

Answer 1

あなたは（私が好む）レールとのGrape API Frameworkを使用している場合は、https://github.com/ruby-grape/grape-swaggerと自動闊歩ドキュメントを取得することができます - それは定義を解析し、その場でドキュメントを作成します。

Grape on RailsやSinatra、またはRubyを使用する必要がない場合は、https://github.com/fotinakis/swagger-blocksをお勧めします。強力ですが、定義を手動で記述する必要があります。