fix(api-client): use Accept: application/json header by default

.changeset/loud-chicken-sin.md

@@ -0,0 +1,5 @@
+---
+"@shopware/api-client": patch
+---
+
+Added `Accept: application/json` default header to get only JSON responses.

packages/api-client-next/src/createAdminApiClient.test.ts

@@ -293,4 +293,37 @@
       "[ApiClientError: Failed request]",
     );
   });
+
+  it(`should by default include "Accept" header with "application/json" value`, async () => {
+    const seoUrlheadersSpy = vi.fn().mockImplementation((param: string) => {});
+    const app = createApp().use(
+      "/order",
+      eventHandler(async (event) => {
+        const headers = getHeaders(event);
+        seoUrlheadersSpy(headers);
+        return {
+          orderResponse: 123,
+          headers,
+        };
+      }),
+    );
+
+    const baseURL = await createPortAndGetUrl(app);
+
+    const client = createAdminAPIClient<operations, operationPaths>({
+      baseURL,
+      sessionData: {
+        accessToken: "Bearer my-access-token",
+        refreshToken: "my-refresh-token",
+        expirationTime: Date.now() + 1000 * 60,
+      },
+    });
+    await client.invoke("getOrderList get /order?limit,page,query", {});
+
+    expect(seoUrlheadersSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        accept: "application/json",
+      }),
+    );
+  });
 });

packages/api-client-next/src/createApiClient.test.ts

@@ -41,7 +41,6 @@ describe("createAPIClient", () => {
     const app = createApp().use(
       "/checkout/cart",
       eventHandler(async (event) => {
-        setHeader;
         return {
           headers: event.node.req.headers,
         };
@@ -144,4 +143,32 @@ describe("createAPIClient", () => {
       "[ApiClientError: Failed request]",
     );
   });
+
+  it(`should by default include "Accept" header with "application/json" value`, async () => {
+    const seoUrlheadersSpy = vi.fn().mockImplementation((param: string) => {});
+    const app = createApp().use(
+      "/checkout/cart",
+      eventHandler(async (event) => {
+        const requestHeaders = getHeaders(event);
+        seoUrlheadersSpy(requestHeaders);
+        return {};
+      }),
+    );
+
+    const baseURL = await createPortAndGetUrl(app);
+
+    const client = createAPIClient<operations, operationPaths>({
+      accessToken: "123",
+      contextToken: "456",
+      baseURL,
+    });
+
+    await client.invoke("readCart get /checkout/cart");
+
+    expect(seoUrlheadersSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        accept: "application/json",
+      }),
+    );
+  });
 });

packages/api-client-next/src/index.ts

@@ -78,6 +78,7 @@ export function createAPIClient<
 }) {
   const defaultHeaders: Record<string, string> = {
     "sw-access-key": params.accessToken,
+    Accept: "application/json",
   };
 
   // protection from setting "null" or "undefined" as a token in API side
@@ -182,6 +183,7 @@ export function createAdminAPIClient<
 
   const defaultHeaders = {
     Authorization: createAuthorizationHeader(sessionData.accessToken),
+    Accept: "application/json",
   };
 
   function updateSessionData(responseData: {