Começar

Primeiro, explicaremos como usar o cliente typed-rx-http Core, e em seguida, descreveremos como conectar o adaptador HTTP público de propriedade do projeto e o serviço de geração automática Swagger apenas nos projetos necessários.

1. Instalação

bash

2. Usar o Core client diretamente sem geração automática

Primeiro, o uso mais básico é createHttpClient<Paths>()criar o client uma vez e chamar o callApi desse client. Paths é geralmente o tipo de paths gerado pelo OpenAPI, mas você também pode usar um tipo definido diretamente que seja compatível com a mesma estrutura.

httpClient.ts

O valor de retorno é sempre Observable

callApi e callApiStream retornam um Observable RxJS, não uma Promise. Quando você usa uma única resposta em uma função async, converta explicitamente com firstValueFrom ou lastValueFrom, e solicitações com vários valores são tratadas com pipe ou subscribe.

3. Seleção: O que é rxjsHttpService/commonService?

O que é referido como rxjsHttpService.ts ou commonService.ts na documentação não é um nome de arquivo fixo gerado automaticamente pela biblioteca. É um arquivo de adaptador HTTP de propriedade direta do projeto. Vários serviços REST gerados automaticamente não criam cada um seu próprio createHttpClient, mas utilizam as funções callApi/callApiStream/cache exportadas por este arquivo como um ponto de entrada comum.

A forma mais simples é criar uma vez o headerStore e o createHttpClient, e re-exportar os métodos da biblioteca como funções do projeto, como no código completo abaixo. Se o serviço gerado automaticamente não utilizar a funcionalidade de cache, essa configuração é suficiente para entender a estrutura.

rxjsHttpService.ts

Para tratar autenticação de sessão, Cookies/Autorização por requisição SSR, cache CSR e cache SSR em um único arquivo em um projeto Next.js real, pode-se expandir como abaixo. Este arquivo também não é um gerado automaticamente, mas sim código do projeto.

rxjsHttpService.ts

O arquivo commonServiceFile refere-se exatamente a este arquivo.

O commonServiceFile do gerador OpenAPI não é uma opção para gerar o arquivo acima. Ele especifica o caminho do arquivo do projeto que importará callApi, callApiStream, callApiClientCache ou callApiServerCache. Portanto, antes de configurar o gerador, é necessário definir primeiro o papel e a exportação deste arquivo.

4. Seleção: Quando usar o serviço de geração automática Swagger.

Depois de conectar o gerador de serviços OpenAPI, não reescrevemos a URL e o tipo de resposta na tela. Importamos a função gerada e passamos apenas o path, params e body necessários.

MemberSearchPage.tsx

tsx

Próximo documento

Cliente HTTP

Verifique o código completo do commonService e o papel de cada componente.

Início Rápido

Verifique primeiro o uso completo da biblioteca, e em seguida, confira exemplos reais de chamadas Front/Backend em um projeto WebFlux + Swagger gerado automaticamente.

OpenAPI Generator

Verifique as regras de geração de tipos e serviços no swagger.json.