@typespec/http-specs 0.1.0-alpha.0

package/specs/payload/content-negotiation/mockapi.ts

@@ -0,0 +1,188 @@
+import {
+  json,
+  MockRequest,
+  ScenarioMockApi,
+  ValidationError,
+  withServiceKeys,
+} from "@typespec/spec-api";
+import { jpgFile, pngFile } from "../../helper.js";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+function sameBodyHandler(req: MockRequest) {
+  switch (req.headers["accept"]) {
+    case "image/png":
+      return {
+        pass: "image/png",
+        status: 200,
+        body: {
+          contentType: "image/png",
+          rawContent: pngFile,
+        },
+      } as const;
+    case "image/jpeg":
+      return {
+        pass: "image/jpeg",
+
+        status: 200,
+        body: {
+          contentType: "image/jpeg",
+          rawContent: jpgFile,
+        },
+      } as const;
+    default:
+      throw new ValidationError(
+        "Unsupported Accept header",
+        `"image/png" | "image/jpeg"`,
+        req.headers["accept"],
+      );
+  }
+}
+
+function differentBodyHandler(req: MockRequest) {
+  switch (req.headers["accept"]) {
+    case "image/png":
+      return {
+        pass: "image/png",
+        status: 200,
+        body: {
+          contentType: "image/png",
+          rawContent: pngFile,
+        },
+      } as const;
+    case "application/json":
+      return {
+        pass: "application/json",
+        status: 200,
+        body: json({
+          content: pngFile.toString("base64"),
+        }),
+      } as const;
+    default:
+      throw new ValidationError(
+        "Unsupported Accept header",
+        `"image/png" | "application/json"`,
+        req.headers["accept"],
+      );
+  }
+}
+
+Scenarios.Payload_ContentNegotiation_SameBody = withServiceKeys(["image/png", "image/jpeg"]).pass([
+  {
+    uri: "/content-negotiation/same-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "image/png",
+      },
+    },
+    response: {
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+      status: 200,
+    },
+    handler: (req) => sameBodyHandler(req),
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/same-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "image/jpeg",
+      },
+    },
+    response: {
+      body: {
+        contentType: "image/jpeg",
+        rawContent: jpgFile,
+      },
+      status: 200,
+    },
+    handler: (req) => sameBodyHandler(req),
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/same-body",
+    method: "get",
+    request: {
+      status: 400,
+      headers: {
+        accept: "wrongAccept",
+      },
+    },
+    response: {
+      status: 400,
+      body: json({
+        message: "Unsupported Accept header",
+        expected: `"image/png" | "image/jpeg"`,
+        actual: "wrongAccept",
+      }),
+    },
+    handler: sameBodyHandler,
+    kind: "MockApiDefinition",
+  },
+]);
+
+Scenarios.Payload_ContentNegotiation_DifferentBody = withServiceKeys([
+  "image/png",
+  "application/json",
+]).pass([
+  {
+    uri: "/content-negotiation/different-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "image/png",
+      },
+    },
+    response: {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    },
+    handler: differentBodyHandler,
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/different-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "application/json",
+      },
+    },
+    response: {
+      status: 200,
+      body: json({
+        content: pngFile.toString("base64"),
+      }),
+    },
+    handler: differentBodyHandler,
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/different-body",
+    method: "get",
+    request: {
+      status: 400,
+      headers: {
+        accept: "wrongAccept",
+      },
+    },
+    response: {
+      status: 400,
+      body: json({
+        message: "Unsupported Accept header",
+        expected: `"image/png" | "application/json"`,
+        actual: "wrongAccept",
+      }),
+    },
+    handler: differentBodyHandler,
+    kind: "MockApiDefinition",
+  },
+]);

package/specs/payload/json-merge-patch/main.tsp

@@ -0,0 +1,184 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+@doc("Test for merge-patch+json content-type")
+@scenarioService("/json-merge-patch")
+namespace Payload.JsonMergePatch;
+
+@doc("Details about a resource.")
+model Resource {
+  name: string;
+  description?: string;
+  map?: Record<InnerModel>;
+  array?: InnerModel[];
+  intValue?: int32;
+  floatValue?: float32;
+  innerModel?: InnerModel;
+  intArray?: int32[];
+}
+
+@doc("Details about a resource for patch operation.")
+model ResourcePatch {
+  description?: string;
+  map?: Record<InnerModel>;
+  array?: InnerModel[];
+  intValue?: int32;
+  floatValue?: float32;
+  innerModel?: InnerModel;
+  intArray?: int32[];
+}
+
+@doc("It is the model used by Resource model")
+model InnerModel {
+  name?: string;
+  description?: string;
+}
+
+@scenario
+@scenarioDoc("""
+  
+  Expected input body:
+  ```json
+  {
+    "name": "Madge",
+    "description": "desc",
+    "map": {
+      "key": {
+        "name": "InnerMadge",
+        "description": "innerDesc"
+      }
+    },
+    "array": [
+      {
+        "name": "InnerMadge",
+        "description": "innerDesc"
+      }
+    ],
+    "intValue": 1,
+    "floatValue": 1.1,
+    "innerModel": {
+      "name": "InnerMadge",
+      "description": "innerDesc"
+    },
+    "intArray": [1, 2, 3]
+  }
+  ```
+  
+  Expected response body:
+  ```json
+  {
+    "name": "Madge",
+    "description": "desc",
+    "map": {
+      "key": {
+        "name": "InnerMadge",
+        "description": "innerDesc"
+      }
+    },
+    "array": [
+      {
+        "name": "InnerMadge",
+        "description": "innerDesc"
+      }
+    ],
+    "intValue": 1,
+    "floatValue": 1.1,
+    "innerModel": {
+      "name": "InnerMadge",
+      "description": "innerDesc"
+    },
+    "intArray": [1, 2, 3]
+  }
+  ```
+  """)
+@doc("Test content-type: application/merge-patch+json with required body")
+@route("/create/resource")
+@put
+op createResource(@body body: Resource): Resource;
+
+@scenario
+@scenarioDoc("""
+  Should serialize null values with merge-patch+json enabled.
+  
+  Expected input body:
+  ```json
+  {
+    "description": null,
+    "map": {
+      "key": {
+        "description": null
+      },
+      "key2": null
+    },
+    "array": null,
+    "intValue": null,
+    "floatValue": null,
+    "innerModel": null,
+    "intArray": null
+  }
+  ```
+  
+  Expected response body:
+  ```json
+  {
+    name: "Madge",
+    map: {
+      key: {
+        name: "InnerMadge"
+      }
+    }
+  }
+  ```
+  """)
+@doc("Test content-type: application/merge-patch+json with required body")
+@route("/update/resource")
+@patch
+op updateResource(
+  @header("content-type") contentType: "application/merge-patch+json",
+  @body body: ResourcePatch,
+): Resource;
+
+@scenario
+@scenarioDoc("""
+  Should serialize null values with merge-patch+json enabled.
+  
+  Expected input body:
+  ```json
+  {
+    "description": null,
+    "map": {
+      "key": {
+        "description": null
+      },
+      "key2": null
+    },
+    "array": null,
+    "intValue": null,
+    "floatValue": null,
+    "innerModel": null,
+    "intArray": null
+  }
+  ```
+  
+  Expected response body:
+  ```json
+  {
+    name: "Madge",
+    map: {
+      key: {
+        name: "InnerMadge"
+      }
+    }
+  }
+  ```
+  """)
+@doc("Test content-type: application/merge-patch+json with optional body")
+@route("/update/resource/optional")
+@patch
+op updateOptionalResource(
+  @header("content-type") contentType: "application/merge-patch+json",
+  @body body?: ResourcePatch,
+): Resource;

package/specs/payload/json-merge-patch/mockapi.ts

@@ -0,0 +1,95 @@
+import { json, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+export const expectedCreateBody = {
+  name: "Madge",
+  description: "desc",
+  map: {
+    key: {
+      name: "InnerMadge",
+      description: "innerDesc",
+    },
+  },
+  array: [
+    {
+      name: "InnerMadge",
+      description: "innerDesc",
+    },
+  ],
+  intValue: 1,
+  floatValue: 1.1,
+  innerModel: {
+    name: "InnerMadge",
+    description: "innerDesc",
+  },
+  intArray: [1, 2, 3],
+};
+
+export const expectedUpdateBody = {
+  description: null,
+  map: {
+    key: {
+      description: null,
+    },
+    key2: null,
+  },
+  array: null,
+  intValue: null,
+  floatValue: null,
+  innerModel: null,
+  intArray: null,
+};
+
+Scenarios.Payload_JsonMergePatch_createResource = passOnSuccess({
+  uri: "/json-merge-patch/create/resource",
+  method: "put",
+  request: {
+    body: expectedCreateBody,
+  },
+  response: {
+    status: 200,
+    body: json(expectedCreateBody),
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Payload_JsonMergePatch_updateResource = passOnSuccess({
+  uri: "/json-merge-patch/update/resource",
+  method: "patch",
+  request: {
+    body: expectedUpdateBody,
+  },
+  response: {
+    status: 200,
+    body: json({
+      name: "Madge",
+      map: {
+        key: {
+          name: "InnerMadge",
+        },
+      },
+    }),
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Payload_JsonMergePatch_updateOptionalResource = passOnSuccess({
+  uri: "/json-merge-patch/update/resource/optional",
+  method: "patch",
+  request: {
+    body: expectedUpdateBody,
+  },
+  response: {
+    status: 200,
+    body: json({
+      name: "Madge",
+      map: {
+        key: {
+          name: "InnerMadge",
+        },
+      },
+    }),
+  },
+  kind: "MockApiDefinition",
+});

package/specs/payload/media-type/main.tsp

@@ -0,0 +1,52 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+/**
+ * Test the payload with different media types and different types of the payload itself.
+ */
+@scenarioService("/payload/media-type")
+namespace Payload.MediaType;
+
+@route("/string-body")
+namespace StringBody {
+  @scenario
+  @scenarioDoc("""
+    Expected request body is a string '{cat}'.
+    """)
+  @post
+  @route("/sendAsText")
+  op sendAsText(@header contentType: "text/plain", @body text: string): OkResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Expected response body is a string '{cat}'.
+    """)
+  @get
+  @route("/getAsText")
+  op getAsText(): {
+    @header contentType: "text/plain";
+    @body text: string;
+  };
+
+  @scenario
+  @scenarioDoc("""
+    Expected request body is "foo".
+    """)
+  @post
+  @route("/sendAsJson")
+  op sendAsJson(@header contentType: "application/json", @body text: string): OkResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Expected response body is "foo".
+    """)
+  @get
+  @route("/getAsJson")
+  op getAsJson(): {
+    @header contentType: "application/json";
+    @body text: string;
+  };
+}

package/specs/payload/media-type/mockapi.ts

@@ -0,0 +1,63 @@
+import { json, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Payload_MediaType_StringBody_sendAsText = passOnSuccess({
+  uri: "/payload/media-type/string-body/sendAsText",
+  method: "post",
+  request: {
+    body: "{cat}",
+    headers: {
+      "Content-Type": "text/plain",
+    },
+  },
+  response: {
+    status: 200,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Payload_MediaType_StringBody_getAsText = passOnSuccess({
+  uri: "/payload/media-type/string-body/getAsText",
+  method: "get",
+  request: {
+    headers: {
+      accept: "text/plain",
+    },
+  },
+  response: {
+    status: 200,
+    body: { rawContent: "{cat}", contentType: "text/plain" },
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Payload_MediaType_StringBody_sendAsJson = passOnSuccess({
+  uri: "/payload/media-type/string-body/sendAsJson",
+  method: "post",
+  request: {
+    body: "foo",
+    headers: {
+      "Content-Type": "application/json",
+    },
+  },
+  response: {
+    status: 200,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Payload_MediaType_StringBody_getAsJson = passOnSuccess({
+  uri: "/payload/media-type/string-body/getAsJson",
+  method: "get",
+  request: {
+    headers: {
+      accept: "application/json",
+    },
+  },
+  response: {
+    status: 200,
+    body: json("foo"),
+  },
+  kind: "MockApiDefinition",
+});