如何使用控制器外部的apipie创建api文档

Question

我正在使用apipie来获取API文档。 我现在面临的问题是，为文档提供的大量信息会破坏我在控制器中的代码结构。

如何在控制器文件外编写文档， 那么代码 structure 是否可读？

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