为后端ror应用程序提供招摇过市的ui

xienkqul  于 2021-09-29  发布在  Java
关注(0)|答案(1)|浏览(271)

我有一个RubyonRails应用程序,它没有Web服务器,因为它只向客户端公开api。现在,我有一个关于这些API的 swagger 的文档。有哪些可能的方法可以在url上为招摇过市的用户界面提供服务?由于没有web服务器,我想知道是否有其他相同的选项。谢谢

kgsdhlau

kgsdhlau1#

你可能知道rswag gem,一种rspec驱动的招摇过市机制。就我个人而言,我并不喜欢这种方法,但gem为我们提供了一种将url简单地转换为招摇过市描述的方法。以下是您可以做的:
归档

gem `rswag`

在config/routes.rb中

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

创建一个 swagger 目录,并将api描述文件放在那里(例如petstore)。(亚马尔)
启动应用程序并在http://localhost:3000/api-这里会有你的描述
但是
在我的拙见中,最好单独运行招摇过市的描述,而不要将应用程序生命周期与公共文档联系起来。我通常使用此命令(或类似命令)在附近的某个地方发布swagger

docker run --rm -it \
    -p 80:8080 \
    -v $(pwd):/swagger \
    -e SWAGGER_JSON=/swagger/swagger.yaml \
    swaggerapi/swagger-ui

相关问题