api - OAuth2 を使用して RAML を使用して API を記述する方法

Question

OAuth2 を使った API を RAML で記述したい

自分の API の RAML と比較するために使用できるソリューションや例はありますか?

Answer 1

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

セキュリティスキーム:
    - oauth_2_0:
        説明: |
            Dropbox は、すべての API リクエストを認証するために OAuth 2.0 をサポートしています。
        タイプ: OAuth 2.0
        説明者:
            ヘッダー:
                承認:
                    説明: |
                       有効な OAuth 2 アクセス トークンを送信するために使用されます。使用禁止
                       「access_token」クエリ文字列パラメーターを使用します。
                    タイプ: 文字列
            クエリパラメータ:
                アクセストークン：
                    説明: |
                       有効な OAuth 2 アクセス トークンを送信するために使用されます。と一緒に使用しないでください
                       「承認」ヘッダー
                    タイプ: 文字列
            反応：
                401:
                    説明: |
                        不良または期限切れのトークン。これは、ユーザーまたは Dropbox が
                        アクセス トークンが取り消されたか期限切れになった。修正するには、再実行する必要があります
                        ユーザーを認証します。
                403:
                    説明: |
                        不適切な OAuth リクエスト (間違ったコンシューマー キー、不適切なナンス、期限切れ
                        タイムスタンプ...)。残念ながら、ここではユーザーの再認証は役に立ちません。
        設定：
          authenticationUri: https://www.dropbox.com/1/oauth2/authorize
          accessTokenUri: https://api.dropbox.com/1/oauth2/token
          authenticationGrants: [コード、トークン]