ruby-on-rails - 葡萄/招摇中的嵌套资源
问题描述
在我正在使用的项目中
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 文档中,这是以所有路径都属于用户命名空间的方式显示的
如何将这些路径分成几部分?
解决方案
虽然我没有使用过grape-swagger,但您可以通过使用tags
并分配给每个端点 a 来实现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-
推荐阅读
- visual-studio-code - VSCode 用户输入法(扩展开发API)
- python - 如何纠正django中的帐户激活错误
- vue.js - 如何改变 vue-toasted 弹出的方向
- pine-script - 忽略先前的值
- python - 我成功下载了烧瓶,但“ModuleNotFoundError:没有名为‘app’的模块”
- java - 使用 Gradle 构建 - 提供的 javaHome 必须是有效目录
- netsuite - SuiteScript 我可以将一个大小超过 10Mb 的文件内容转换为文件的任何方法
- reactjs - 如何在 React 中渲染部件
- c++ - 从第三方动态库中的具有虚函数的类继承
- python - 无法实例化抽象
具有抽象属性权重