Cliente HTTP

Os Paths injetados em createHttpClient<Paths>() são o contrato da requisição. A URL e o método são definidos pela chave de Paths, queryString e pathVariable são definidos nos parâmetros, e o corpo é determinado pelo requestBody.

O tipo de resposta é especificado pelo chamador em callApi<R>(). O Core não infere automaticamente o tipo de resposta a partir das respostas do OpenAPI.

typed-rx-http não força o uso de ResponseWrapper. Se a resposta do servidor for um wrapper, especifique o tipo do wrapper como R, caso contrário, especifique o tipo real da resposta.

commonService não é um nome de classe especial fornecido por @byeolnaerim/typed-rx-http, mas refere-se a um arquivo de propriedade do usuário usado para reunir políticas HTTP comuns do projeto em um só lugar. O nome do arquivo é livre e no exemplo abaixo usamos o nome real do projeto, rxjsHttpService.ts.

Em vez de repetir createHttpClient em cada tela e serviço gerado automaticamente, usamos callApi e callApiStream gerados por este arquivo como um ponto de entrada comum. Portanto, se você modificar as regras de renovação de autenticação, transmissão de cabeçalho SSR, cache e tratamento de erros uma vez, isso se aplicará a todos os serviços gerados.

1. Mínimo funcional

A essência do commonService é o código abaixo. Crie uma vez o headerStore e o cliente HTTP tipado, e exporte callApi/callApiStream que o serviço gerado usará em comum. uploadFile e createSSEObservable também podem ser expostos a partir do mesmo cliente.

2. Next.js + autenticação de sessão + cache CSR/SSR incluído como uma extensão

Abaixo está um exemplo completo do projeto que adiciona autenticação de sessão, cabeçalho SSR e cache CSR/SSR ao mesmo adaptador público. Se o serviço gerado importar o wrapper de cache, esta forma será a referência. Basta copiar, ajustar a importação de setLogin, a posição de ApiTypes e CacheNames, o caminho da API de autenticação, as variáveis de ambiente e o caminho de não autorizado para se adequar ao seu projeto.

O gerador calcula o caminho relativo do commonServiceFile e insere a importação em cada serviço. A tela importa funções geradas sem chamar diretamente o arquivo público, e a função gerada converte path, params, body em pathVariable, queryString, body de ServiceArguments para passar para callApi.

APIs REST que respondem uma vez e terminam, como busca, armazenamento e exclusão, podem ser recebidas como Observable gerado.firstValueFromAssim, podem ser usadas naturalmente dentro de funções assíncronas existentes.

Na tela, parâmetrosapenas aparece, mas dentro do serviço gerado estão a URL, o método HTTP e o tipo de resposta. Os parâmetros de consulta são sempre{ params: { ... } }passados como.

Solicitações que recebem vários valores, como progresso de trabalho ou fluxo RSocketsubscribesão recebidas e a assinatura é cancelada quando o componente desaparece.

Em projetos que não usam o gerador de serviços ou ao verificar um endpoint temporário antes da geração, você pode chamar diretamente callApi do serviço público. O tipo de solicitação é verificado nos caminhos e o tipo de resposta é especificado genericamente pelo chamador.