如何使用 RAML 描述使用 OAuth2 的 API [关闭]

Posted

技术标签:

【中文标题】如何使用 RAML 描述使用 OAuth2 的 API [关闭]【英文标题】:How to use RAML to describe an API using OAuth2 [closed] 【发布时间】:2014-02-03 19:23:37 【问题描述】:

我想用 RAML 来描述一个使用 OAuth2 的 API

有没有人可以用我自己的 RAML 来比较我的 api 的解决方案或示例?

【问题讨论】:

为什么关闭? 关闭原因在上方突出显示:您的问题是题外话,因为它请求了场外资源。 @njuffa 我要求一个解决方案,我得到了一个受欢迎的答案!这不是这个网站的目的吗? 每个社区都有规则。我不制定这些规则。我只是指出了您的问题所违反的特定规则,希望能回答您的问题。 【参考方案1】:

来自https://github.com/raml-org/raml-spec/blob/master/08_security.md#declaration:

安全方案: - oauth_2_0: 描述: | Dropbox 支持 OAuth 2.0 来验证所有 API 请求。 类型:OAuth 2.0 描述者: 标题: 授权: 描述: | 用于发送有效的 OAuth 2 访问令牌。不使用 使用“access_token”查询字符串参数。 类型:字符串 查询参数: 访问令牌: 描述: | 用于发送有效的 OAuth 2 访问令牌。请勿与 “授权”标头 类型:字符串 回复: 401: 描述: | 错误或过期的令牌。如果用户或 Dropbox 撤销或过期访问令牌。要修复,您应该重新 验证用户。 403: 描述: | 错误的 OAuth 请求(错误的使用者密钥、错误的 nonce、过期 时间戳...)。不幸的是,在这里重新验证用户身份将无济于事。 设置: 授权Uri:https://www.dropbox.com/1/oauth2/authorize accessTokenUri:https://api.dropbox.com/1/oauth2/token 授权:[代码,令牌]

【讨论】:

我想这是针对 raml 0.8 标准的。 1.0 的有效声明是什么样的?

以上是关于如何使用 RAML 描述使用 OAuth2 的 API [关闭]的主要内容,如果未能解决你的问题,请参考以下文章

使用RAML描述API文档信息的一些用法整理

RAML:如何要求参数 A 或参数 B

RAML - 如何设计带有参数的端点?

如何在 RAML 中定义一个全局变量

如何在 Anypoint Studio 项目中更改 RAML 版本

如何在 Raml 的外部文件中定义一个类型的数组?