Schein-API-Aufrufe mit Jest meistern: Ein umfassendes Tutorial

Das Verspotten von API-Aufrufen mit Jest ist entscheidend für das Schreiben effizienter, schneller und zuverlässiger Tests. Dieses Tutorial führt Sie durch die wesentlichen Techniken zur Steuerung simulierter Antworten mithilfe der umfangreichen Bibliothek und Adapter von Jest für fortgeschrittene Szenarien.

Beim Schreiben von Tests für Code, der API-Aufrufe ausführt, ist es wichtig, diese Aufrufe zu simulieren. Diese Strategie stellt sicher, dass Ihre Tests zuverlässig, schnell und unabhängig von externen Diensten sind. Jest, ein beliebtes JavaScript-Testframework, bietet mehrere Methoden, um API-Aufrufe einfach zu simulieren. Lassen Sie uns die verschiedenen Ansätze erkunden, die Sie verwenden können.

Verwenden von jest.mock()

Eine einfache Möglichkeit, API-Aufrufe in Jest zu verspotten, besteht darin, die Funktion jest.mock() zu verwenden, um das gesamte Modul zu verspotten, das die API-Anfrage stellt. Hier ist ein Beispiel:

// api.js
import axios from 'axios';

export const getUsers = () => {
  return axios.get('/users');
};

// api.test.js
import axios from 'axios';
import { getUsers } from './api';

jest.mock('axios');

test('getUsers returns data from API', async () => {
  const users = [{ id: 1, name: 'John' }];
  axios.get.mockResolvedValueOnce({ data: users });

  const result = await getUsers();

  expect(axios.get).toHaveBeenCalledWith('/users');
  expect(result.data).toEqual(users);
});

In diesem Beispiel verwenden wir jest.mock('axios'), um das gesamte Axios-Modul automatisch zu verspotten. Anschließend verwenden wir axios.get.mockResolvedValueOnce(), um die Antwort für den nächsten axios.get-Aufruf zu verspotten. Unser Test überprüft, ob die API korrekt aufgerufen wurde und gibt die simulierten Daten zurück.

Verwenden manueller Mocks

Ein anderer Ansatz besteht darin, das Modul, das den API-Aufruf durchführt, manuell zu verspotten, indem ein __mocks__-Ordner erstellt und eine Scheinimplementierungsdatei darin abgelegt wird:

// __mocks__/axios.js
export default {
  get: jest.fn(() => Promise.resolve({ data: {} })),
  post: jest.fn(() => Promise.resolve({ data: {} })),
  // ...
};

Jetzt können Sie in Ihrem Test für jeden Test unterschiedliche Antworten simulieren:

// api.test.js
import axios from 'axios';
import { getUsers } from './api';

jest.mock('axios');

test('getUsers returns data from API', async () => {
  const users = [{ id: 1, name: 'John' }];
  axios.get.mockResolvedValueOnce({ data: users });

  const result = await getUsers();

  expect(axios.get).toHaveBeenCalledWith('/users');
  expect(result.data).toEqual(users);
});

Mit diesem manuellen Mock haben Sie die volle Kontrolle und können verschiedene Axios-Methoden, wie Get und Post, mit Ihren eigenen Implementierungen nachahmen.

Verwendung des Axios-Mock-Adapters

Für eine erweiterte Verspottung von Axios-Anfragen können Sie die axios-mock-adapter-Bibliothek verwenden. Installieren Sie es zunächst:

npm install axios-mock-adapter --save-dev

Dann in Ihren Tests:

// api.test.js
import axios from 'axios';
import MockAdapter from 'axios-mock-adapter';
import { getUsers } from './api';

describe('getUsers', () => {
  let mock;

  beforeAll(() => {
    mock = new MockAdapter(axios);
  });

  afterEach(() => {  
    mock.reset();
  });

  test('returns users data', async () => {
    const users = [{ id: 1, name: 'John' }];
    mock.onGet('/users').reply(200, users);

    const result = await getUsers();

    expect(result.data).toEqual(users);  
  });
});

Mit axios-mock-adapter können Sie Anfragen basierend auf URLs, Parametern, Headern und mehr verspotten. Sie können auch Fehler und Zeitüberschreitungen simulieren.

Injizieren einer simulierten Axios-Instanz

Wenn Ihr Code Axios direkt verwendet, besteht eine andere Möglichkeit darin, während der Tests eine simulierte Axios-Instanz in Ihren Code einzufügen:

// api.js
import axios from 'axios';

export const getUsers = () => {
  return axios.get('/users');
};

// api.test.js
import axios from 'axios';
import { getUsers } from './api';

jest.mock('axios', () => ({
  get: jest.fn(),
}));

test('getUsers returns data from API', async () => {
  const users = [{ id: 1, name: 'John' }];
  axios.get.mockResolvedValueOnce({ data: users });

  const result = await getUsers();

  expect(axios.get).toHaveBeenCalledWith('/users');
  expect(result.data).toEqual(users);
});

Hier verspotten wir Axios selbst, nicht das gesamte Modul, und stellen unsere eigene simulierte Get-Funktion bereit.

Tipps zum Verspotten von API-Aufrufen

Hier sind einige Tipps, die Sie beachten sollten, wenn Sie API-Aufrufe in Jest verspotten:

1. Mocks zwischen Tests zurücksetzen: Verwenden Sie beforeEach und afterEach, um sicherzustellen, dass Tests unabhängig sind.
2. Nur ​​notwendige Funktionen verspotten: Vermeiden Sie es, zu viel zu verspotten. Konzentrieren Sie sich auf die Funktionen und Module, die Ihr Code tatsächlich verwendet.
3. Fehlerfälle testen: Scheinfehler und unerwartete Antworten, um zu testen, wie Ihr Code mit Fehlern umgeht.
4. Wiederverwendbare Mock Fixtures: Erstellen Sie wiederverwendbare Mock Fixtures für allgemeine API-Antworten.

Mock-APIs mit EchoAPI

EchoAPI ist ein hervorragendes Tool für das Design, Debuggen und Testen von API-Schnittstellen. Es vereinfacht den Entwicklungsprozess, indem es eine integrierte Umgebung bereitstellt, in der Entwickler APIs effizient erstellen, testen und validieren können. Ein Hauptmerkmal von EchoAPI ist die Unterstützung von Scheindiensten, die es Entwicklern ermöglicht, API-Antworten für effektive Tests zu simulieren. So richten Sie eine Schein-API in EchoAPI ein:

1. Erstellen Sie eine neue HTTP-Anfrage

Definieren Sie die URL als /echoapi/login.

2. Richten Sie erwartete Antworten ein

Gehen Sie zum Designbereich und konfigurieren Sie die erwarteten Antworten.

Für eine erfolgreiche Antwort konfigurieren Sie den JSON wie folgt:

// api.js
import axios from 'axios';

export const getUsers = () => {
  return axios.get('/users');
};

// api.test.js
import axios from 'axios';
import { getUsers } from './api';

jest.mock('axios');

test('getUsers returns data from API', async () => {
  const users = [{ id: 1, name: 'John' }];
  axios.get.mockResolvedValueOnce({ data: users });

  const result = await getUsers();

  expect(axios.get).toHaveBeenCalledWith('/users');
  expect(result.data).toEqual(users);
});

Für eine Fehlerreaktion konfigurieren Sie den JSON wie folgt:

// __mocks__/axios.js
export default {
  get: jest.fn(() => Promise.resolve({ data: {} })),
  post: jest.fn(() => Promise.resolve({ data: {} })),
  // ...
};

3. Konfigurieren Sie die Mock-Triggering-Bedingungen

Legen Sie im Abschnitt „Mock“ die Auslösebedingungen für den Anfragetext fest. Wenn „email“="test@echoapi.com" und „password“="123456" sind, wählen Sie als erwartete Antwort „Erfolgreich“ aus. Wählen Sie für alle anderen Bedingungen „Fehler“ als erwartete Reaktion aus.

4. Aktivieren Sie den Mock-Modus

Aktivieren Sie Scheindienste und wechseln Sie zur Scheinumgebung, bevor Sie diese API-Anfrage senden.

Frontend-Entwicklung

Durch die Verwendung von Schein-APIs in der Frontend-Entwicklung können Sie sofort an Funktionen arbeiten, ohne darauf warten zu müssen, dass das Backend bereit ist. Dieser parallele Entwicklungsansatz beschleunigt den Gesamtprozess.

Automatisierte Tests

Mock-APIs bieten konsistente Antworten für automatisierte Tests und erleichtern so das Schreiben zuverlässiger Tests. Tools wie Jest und Cypress können in Schein-APIs integriert werden, um verschiedene Komponenten und Abläufe zu testen.

Prototyping

Bei der Erstellung von Prototypen oder Proofs of Concept ermöglichen Schein-APIs die schnelle Einrichtung notwendiger Backend-Interaktionen, ohne dass tatsächliche Backend-Dienste erstellt werden müssen.

Abschluss

Das Verspotten von API-Aufrufen ist eine grundlegende Fähigkeit zum Schreiben zuverlässiger und schneller Tests, insbesondere im Umgang mit externen Abhängigkeiten. Jest bietet mehrere Möglichkeiten zum Verspotten von API-Aufrufen, vom Verspotten ganzer Module mit jest.mock() über das manuelle Verspotten von Modulen bis hin zur Verwendung von Bibliotheken wie axios-mock-adapter für fortgeschrittenere Fälle. Der Schlüssel liegt darin, den richtigen Ansatz basierend auf Ihren Anforderungen zu wählen und gleichzeitig Ihre Tests unabhängig zu halten und sich auf den zu testenden Code zu konzentrieren.

Darüber hinaus bietet EchoAPI robuste Tools zum Verspotten von APIs und verbessert so Ihre Entwicklungs- und Testworkflows. Durch die Beherrschung dieser Techniken können Sie belastbare Tests schreiben und effiziente, effektive API-Interaktionen aufrechterhalten.

Warum also warten? Beginnen Sie noch heute mit der Nutzung dieser Spotttechniken und Tools wie EchoAPI, um Ihren Entwicklungsworkflow zu verbessern!

Das obige ist der detaillierte Inhalt vonSchein-API-Aufrufe mit Jest meistern: Ein umfassendes Tutorial. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!