mount Rswag:: Ui:: Engine = > "/api-docs"
mount Swag::Api::Engine = >"/api-docs"
创建一个简单的配置/初始化器/招摇过市。铷
Rswag::Api.configure do |c|
c.swagger_root = Rails.root.to_s + '/swagger'
end
Swag::Ui.configure do |c|
c.swagger_endpoint '/api-docs/petstore.yaml', 'API V1 Docs'
end
1条答案
按热度按时间kgsdhlau1#
你可能知道rswag gem,一种rspec驱动的招摇过市机制。就我个人而言,我并不喜欢这种方法,但gem为我们提供了一种将url简单地转换为招摇过市描述的方法。以下是您可以做的:
归档
在config/routes.rb中
创建一个简单的配置/初始化器/招摇过市。铷
创建一个
swagger
目录,并将api描述文件放在那里(例如petstore)。(亚马尔)启动应用程序并在http://localhost:3000/api-这里会有你的描述
但是
在我的拙见中,最好单独运行招摇过市的描述,而不要将应用程序生命周期与公共文档联系起来。我通常使用此命令(或类似命令)在附近的某个地方发布swagger