API診断では、Web上にアップロードしたOpenAPIの定義ファイル(yaml)に対して診断を実行します。
「API診断」でできること
API診断イメージ
診断対象の新規登録
診断対象右上の「+新規登録」をクリック。
「API診断(REST API)」をクリック。
表示されるポップアップ画面へ以下の必要情報を入力し「登録する」をクリック。
- 診断名:任意の診断名を入力
- 定義ファイル(OpenAPI 形式)のURL:Web上にアップロードされたOpenAPIの定義ファイルのURLを指定
※OpenAPI v3.0以上の形式かつ拡張子はyamlもしくはjson形式で、OpenAPIの定義ファイルが作成されている必要があります。
※OpenAPIの定義ファイル内に複数のAPIサーバーが設定されている場合、1つ目のAPIのURLが診断対象となり、Securifyで登録済みのドメインと一致している場合にのみ、診断を実行します。
※API診断実施時は「攻撃的な診断を許可」設定が自動で「オン」になります。「攻撃的な診断を許可」設定についてはこちらをご確認ください。
※以下の情報がOpenAPIの定義ファイル内に存在している必要があります。
- OpenAPIのバージョン
- servers(APIサーバー)
- Securifyに登録済みのドメイン
- paths(パス)
- 診断対象のAPIのエンドポイント情報
以下は参考例になります
openapi:
info:
title:
version:
servers:
- url:
paths:
/:
get:
responses:
'200':
description: Successful operation
その他の設定はこちらをご確認ください。
診断の設定はこちらをご確認ください。