Я использую swagger-блоки для настройки документов для моих API-сервисов (написано Rails). Я должен кодировать много строк, чтобы определить для каждого метода. Но я думаю, что это может повлиять на производительность моего приложения, потому что в него включено много документов.
Кто-нибудь думал так же, и есть ли другие лучшие решения для написания документа в RAILS?
class PetsController < ActionController::Base
include Swagger::Blocks
swagger_path '/pets/{id}' do
operation :get do
key :summary, 'Find Pet by ID'
key :description, 'Returns a single pet if the user has access'
key :operationId, 'findPetById'
key :tags, [
'pet'
]
parameter do
key :name, :id
key :in, :path
key :description, 'ID of pet to fetch'
key :required, true
key :type, :integer
key :format, :int64
end
response 200 do
key :description, 'pet response'
schema do
key :'$ref', :Pet
end
end
response :default do
key :description, 'unexpected error'
schema do
key :'$ref', :ErrorModel
end
end
end
end
def pet
// ...
end
end