api - 如何使用 RAML 描述使用 OAuth2 的 API

Question

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

有没有人有一个解决方案或示例可以用来与我自己的 api 的 RAML 进行比较？

Answer 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
          授权：[代码，令牌]