1. ホーム
  2. swagger

[解決済み] Swagger Spec (swagger.json) で「Authorization: Bearer <token>」を表現する方法

2022-05-07 03:52:18

質問

認証/セキュリティ方式では、以下のようにヘッダを設定する必要があることを伝えようとしています。

Authorization: Bearer <token>

を元にしたものです。 スワッガー・ドキュメント :

securityDefinitions:
  APIKey:
    type: apiKey
    name: Authorization
    in: header
security:
  - APIKey: []

どのように解決するのですか?

もしかしたら、これが役に立つかもしれません。

swagger: '2.0'
info:
  version: 1.0.0
  title: Based on "Basic Auth Example"
  description: >
    An example for how to use Auth with Swagger.

host: basic-auth-server.herokuapp.com
schemes:
  - http
  - https
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
paths:
  /:
    get:
      security:
        - Bearer: []
      responses:
        '200':
          description: 'Will send `Authenticated`'
        '403': 
          description: 'You do not have necessary permissions for the resource'

ここにコピー&ペーストしてお使いください。 http://editor.swagger.io/#/ をクリックしてご確認ください。

また、swagger editorのウェブには、より複雑なセキュリティ設定の例もいくつかありますので、参考になると思います。