RESTful API를 문서화하는 방법은 무엇입니까?

Question

저는 RoR을 처음 사용합니다.

Django REST Swagger과 같이 RESTful API를 문서화 할 수있는 방법이 있습니까?

그럼 내 API를 문서화하기 위해 apipie-rails을 발견했습니다. 내가 lib 디렉토리/apipie/application.rb에 다음 코드를 발견

Spree::Api::BaseController.class_eval do 

    # Some overrided functions 

end 

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

base_controller_decorator.rb : 내가 Spree과 통합 할 때

는하지만, 나는 다음과 같은 오류가 발생했습니다 :

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을 제안합니다. 강력하지만 정의를 수동으로 작성해야합니다.