PostmanのPost-requestスクリプトでJSON Schemaでレスポンス検証する方法 – 【Postman】

PostmanのPost-requestスクリプトでJSON Schemaでレスポンス検証する方法 – 【Postman】

Postmanの検証コード

Postman公式ドキュメントではChaiのBDDアサーションスタイルを使用していると記載があります。

アサーションの記述
Chai BDD構文を使った様々なアサーションの記述をテストしてみましょう。

Documentation | Postman Japan Workshop | Postman API Network

www.postman.com

chai.jsのBDD構文やmocha等の知見が多少必要と思われますので、JSON Schemaで一発検証する方法もありだと思います。

JSON Schemaを使用した検証コード

JSON Schemaを使用した検証コードです。schemaという定数にJSON Schemaを格納すればレスポンスボディがJSON Schema通りであるかを検証してくれるので便利です。

pm.response.to.have.jsonSchemaを使用します。

const schema = {
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    }
  },
  "additionalProperties": false
}; // このJSON Schemaはサンプルです
pm.test("レスポンスがスキーマ通りであることのテスト", function () {
  pm.response.to.have.jsonSchema(schema);
});

JSON Schemaを使用した検証コード自動生成

以下URLでは、JSON Schemaを入力すればPost-requestのコードを自動生成します。

POSTMAN Script Generator - Response Body | Tools | オンラインエディタ

JSON Shcemaの仕様に沿ったレスポンスボディかを検証するPOSTMANのテストコードを生成するオンラインエディタのサイトです。

exp-apps.onrender.com

高橋

KHI入社して退社。今はCONFRAGEで正社員です。関西で140-170/80～120万から受け付けております^^
得意技はJS(ES20xx),Java,AWSの大体のリソースです
コメントはやさしくお願いいたします^^
座右の銘は、「狭き門より入れ」「願わくは、我に七難八苦を与えたまえ」です^^