OAS 2 このページは、OpenAPI仕様バージョン2（旧Swagger）に適用されます。
最新バージョンについては、OpenAPI 3ページをご覧ください。

基本認証

基本認証は、HTTPプロトコルに組み込まれている非常にシンプルな認証スキームです。クライアントは、スペースの後にbase64でエンコードされた`username:password`文字列が続く`Basic`ワードを含む`Authorization`ヘッダー付きのHTTPリクエストを送信します。たとえば、`demo` / `p@55w0rd`クレデンシャルを含むヘッダーは、次のようにエンコードされます。

Authorization: Basic ZGVtbzpwQDU1dzByZA==

注： base64は簡単にデコードできるため、基本認証はHTTPS / SSLなどの他のセキュリティメカニズムと組み合わせてのみ使用する必要があります。

基本認証は簡単に定義できます。グローバル`securityDefinitions`セクションに、`type: basic`と任意の名前（この例では* basicAuth *）のエントリを追加します。次に、`security`セクションを使用して、API全体または特定の操作にセキュリティを適用します。

securityDefinitions:
  basicAuth:
    type: basic

# To apply Basic auth to the whole API:
security:
  - basicAuth: []

paths:
  /something:
    get:
      # To apply Basic auth to an individual operation:
      security:
        - basicAuth: []
      responses:
        200:
          description: OK (successfully authenticated)

401レスポンス

クレデンシャルが欠落しているか正しくないリクエストに対して返される401「Unauthorized」レスポンスを定義することもできます。このレスポンスには、`WWW-Authenticate`ヘッダーが含まれており、メンションすることをお勧めします。他の一般的なレスポンスと同様に、401レスポンスはグローバル`responses`セクションで定義し、複数の操作から参照できます。

paths:
  /something:
    get:
      ...
      responses:
        ...
        401:
           $ref: '#/responses/UnauthorizedError'
    post:
      ...
      responses:
        ...
        401:
          $ref: '#/responses/UnauthorizedError'
responses:
  UnauthorizedError:
    description: Authentication information is missing or invalid
    headers:
      WWW_Authenticate:
        type: string

  

お探しのものは見つかりませんか？ コミュニティに質問する
間違いを見つけましたか？ お知らせください