コントローラ外のapipieを使用してapiドキュメントを作成する方法

Question

APIドキュメントにはapipieを使用しています。 私が今直面している問題は、ドキュメンテーションのために提供される大量の情報がコントローラのコード構造を破壊していることです。

コントローラーファイル の外部に文書を書くにはどうすれば構造のコードを読むことができますか？

Answer 1

あなたは（リンクから例）物事をまとめると、この文書https://ilyabylich.svbtle.com/apipie-amazing-tool-for-documenting-your-rails-api

にapipie外のコントローラを使用する方法の素敵な説明を見つけることができます：あなたの参照および例えば

# app/docs/users_doc.rb 
module UsersDoc 
# we need the DSL, right? 
extend Apipie::DSL::Concern 

api :GET, '/users', 'List users' 
def show 
    # Nothing here, it's just a stub 
end 
end 

# app/controller/users_controller.rb 
class UsersController < ApplicationController 
    include UsersDoc 

    def show 
    # Application code goes here 
    # and it overrides blank method 
    # from the module 
    end 
end