Commencer

Je vais d'abord expliquer l'utilisation du client typed-rx-http Core lui-même, puis expliquer comment connecter l'adaptateur HTTP public possédé par le projet et le service de génération automatique Swagger uniquement dans les projets nécessaires.

1. Installation

bash

2. Utilisation directe du client Core sans génération automatique

Tout d'abord, la méthode d'utilisation la plus basique est createHttpClient<Paths>()de créer une fois le client, puis d'appeler callApi de ce client. Paths est généralement le type de chemins généré par OpenAPI, mais vous pouvez également utiliser un type défini manuellement qui a la même structure.

httpClient.ts

La valeur de retour est toujours Observable

callApi et callApiStream renvoient un Observable RxJS, pas une promesse. Lorsque vous utilisez une réponse unique dans une fonction async, convertissez-la explicitement avec firstValueFrom ou lastValueFrom, et les requêtes avec plusieurs valeurs sont traitées avec pipe ou subscribe.

3. Choix : Qu'est-ce que rxjsHttpService/commonService ?

Ce qui est appelé rxjsHttpService.ts ou commonService.ts dans la documentation n'est pas un nom de fichier fixe généré automatiquement par la bibliothèque. C'est un fichier d'adaptateur HTTP possédé directement par le projet. Plusieurs services REST générés automatiquement n'appellent pas chacun createHttpClient, mais utilisent les fonctions callApi/callApiStream/cache exportées par ce fichier comme point d'entrée commun.

La forme la plus simple consiste à créer une fois headerStore et createHttpClient comme dans le code complet ci-dessous et à réexporter les méthodes de la bibliothèque en tant que fonctions du projet. Si vous n'utilisez pas la fonction de cache dans le service généré automatiquement, cette configuration suffit pour comprendre la structure.

rxjsHttpService.ts

Pour gérer l'authentification de session, les cookies/autorisation par requête SSR, le cache CSR et le cache SSR dans un projet Next.js réel, vous pouvez l'étendre comme ci-dessous. Ce fichier n'est pas non plus un produit généré automatiquement, mais du code de projet.

rxjsHttpService.ts

Ce à quoi fait référence commonServiceFile est ce fichier.

Le commonServiceFile de l'OpenAPI generator n'est pas une option pour générer le fichier ci-dessus. Il spécifie le chemin du fichier du projet qui importera callApi, callApiStream, callApiClientCache ou callApiServerCache. Donc, avant de configurer le générateur, vous devez d'abord définir le rôle et l'export de ce fichier.

4. Choix : Si vous utilisez le service de génération automatique Swagger,

Après avoir connecté le générateur de service OpenAPI, l'écran ne réécrit pas l'URL et le type de réponse. Il importe les fonctions générées et ne passe que le chemin, les paramètres et le corps nécessaires.

MemberSearchPage.tsx

tsx

Document suivant

Client HTTP

Vérifiez le code complet de commonService et le rôle de chaque composant.

Démarrage rapide

vérifiez d'abord l'utilisation complète de la bibliothèque elle-même, puis examinez les exemples d'appels réels du projet WebFlux + Swagger généré automatiquement.

OpenAPI Generator

Vérifiez les règles de génération des types et des services dans swagger.json.