Swagger 在 Rails Api 中不起作用

Question

gem 'swagger-docs'

rake swagger：文档

轨道服务器

我的控制器在 app/controller/API/user_controller.rb

    module Api
    class UserController < ApplicationController

    swagger_controller :users, "Users"
    swagger_api :create do
        summary "Creates a new User"
        param :form, :name, :string, :required, "Name"
        response :unauthorized
        response :not_acceptable
    end

    def create
            render json: {message: "success"},status: 401
    end

end

结束

但是当我进入时

http://localhost:3000/api-docs.json

它无法正常工作。它不能显示正确的布局。而不是它给出的 json 代码。

{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "/",
"apis": [
 {
   "path": "api/user.{format}",
  "description": "Users"
 }
]
 }

Answer 1

返回 JSON 是 swagger-docs 的默认行为。如果你想从这个screenshot 看到布局，你也需要使用swagger-ui。请参阅此处的示例https://github.com/richhollis/swagger-docs-sample/tree/c33e1e788b8ef5a71c86610fffbb145b243a725b/public/api

希望这会有所帮助:)