葡萄/招摇中的嵌套资源

Question

在我正在使用的项目中

gem 'grape'
gem 'grape-swagger'

我在 API 中有一个命名空间，负责用户端点

namespace :users do
  mount V1::Users::AuthAPI
  mount V1::Users::MaterialsAPI
  ...
end

每个挂载的文件都有自己的命名空间，例如app/api/v1/users/materials_api.rb

namespace :materials do
  ...
end

在 swagger 文档中，这是以所有路径都属于用户命名空间的方式显示的

如何将这些路径分成几个部分？

Answer 1

虽然我没有使用 grape-swagger，但您可以通过使用 tags 并为每个端点分配一个 tag.

来实现

openapi: 3.0.0
....
tags:
  - name: users
   description: something about users
  - name: materials
   description: something about materials
paths:
  /api/v1/users/auth:
    post:
     tags:
       - users
     ...
  /api/v1/users/materials:
    get:
      tags:
        - materials
     ....

该配置应呈现如下内容：

我看到 grape-swagger 有这个 https://github.com/ruby-grape/grape-swagger#tags-

葡萄/招摇中的嵌套资源

Nested resources in grape / swagger

ruby-on-rails

ruby-grape

swagger