feat: add support for json:api content type (#1187)

* feat: add support for json:api content type

* test: update snapshots to add json:api content type

* test: add jsonapi-media-type test

* style: fix format for JSON API spec

* chore(changeset): add support for json:api content type

* chore: update .changeset/plenty-symbols-fail.md

Co-authored-by: Sora Morimoto <[email protected]>

---------

Co-authored-by: Sora Morimoto <[email protected]>

Author: gletournel

.changeset/plenty-symbols-fail.md

@@ -0,0 +1,5 @@
+---
+"swagger-typescript-api": minor
+---
+
+Add support for json:api content type.

src/schema-routes/schema-routes.ts

@@ -22,6 +22,7 @@ import { SpecificArgNameResolver } from "./util/specific-arg-name-resolver.js";
 
 const CONTENT_KIND = {
   JSON: "JSON",
+  JSON_API: "JSON_API",
   URL_ENCODED: "URL_ENCODED",
   FORM_DATA: "FORM_DATA",
   IMAGE: "IMAGE",
@@ -280,6 +281,10 @@ export class SchemaRoutes {
     );
 
   getContentKind = (contentTypes) => {
+    if (contentTypes.includes("application/vnd.api+json")) {
+      return CONTENT_KIND.JSON_API;
+    }
+
     if (
       contentTypes.some((contentType) =>
         contentType.startsWith("application/json"),

templates/base/http-clients/axios-http-client.ejs

@@ -32,6 +32,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
 
 export enum ContentType {
   Json = "application/json",
+  JsonApi = "application/vnd.api+json",
   FormData = "multipart/form-data",
   UrlEncoded = "application/x-www-form-urlencoded",
   Text = "text/plain",

templates/base/http-clients/fetch-http-client.ejs

@@ -43,6 +43,7 @@ type CancelToken = Symbol | string | number;
 
 export enum ContentType {
     Json = "application/json",
+    JsonApi = "application/vnd.api+json",
     FormData = "multipart/form-data",
     UrlEncoded = "application/x-www-form-urlencoded",
     Text = "text/plain",
@@ -103,6 +104,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
     private contentFormatters: Record<ContentType, (input: any) => any> = {
         [ContentType.Json]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
+        [ContentType.JsonApi]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
         [ContentType.Text]: (input:any) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
         [ContentType.FormData]: (input: any) =>
             Object.keys(input || {}).reduce((formData, key) => {

templates/default/procedure-call.ejs

@@ -48,6 +48,7 @@ const wrapperArgs = _
 // RequestParams["type"]
 const requestContentKind = {
     "JSON": "ContentType.Json",
+    "JSON_API": "ContentType.JsonApi",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
     "TEXT": "ContentType.Text",

templates/modular/procedure-call.ejs

@@ -48,6 +48,7 @@ const wrapperArgs = _
 // RequestParams["type"]
 const requestContentKind = {
     "JSON": "ContentType.Json",
+    "JSON_API": "ContentType.JsonApi",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
     "TEXT": "ContentType.Text",