OpenAPI & Gerador de Serviço

Usuários comuns de @byeolnaerim/typed-rx-http, /next ou /rsocket não precisam executar este script e não precisam instalar openapi-typescript em seu projeto.

A geração de tipos OpenAPI requer o CLI openapi-typescript, mas o pacote não o inclui nas dependências comuns. As devDependencies.typescript do typed-rx-http mantêm a versão 6.0.3 do TypeScript, e o script auto node OpenAPI usa um ambiente temporário npx separado.

Na fase básica de geração do OpenAPI, openapi-typescript e [email protected] são executados juntos, portanto, não altera ou usa a versão do TypeScript/openapi-typescript instalada no projeto do usuário.

Se necessário, o comando completo pode ser fixado como openApiTypescriptCommand.

Ou você pode apenas alterar a versão do pacote que compõe o comando básico.

Antes que commonServiceFile apareça no exemplo do gerador, você deve entender este arquivo primeiro. commonServiceFile é o caminho do arquivo que possui as funções HTTP comuns que o serviço gerado importará, não é uma opção que cria arquivos. O nome do arquivo pode ser escolhido livremente, como rxjsHttpService.ts, commonService.ts, etc.

Código completo mínimo funcional

O arquivo abaixo cria uma vez o createHttpClient no projeto e exporta callApi e callApiStream para reutilização pelo serviço gerado. Se cache ou autenticação de sessão não forem necessários, você pode começar com esta estrutura.

Código completo incluindo cache de sessão/CSR/SSR

Se o serviço gerado usar callApiClientCache ou callApiServerCache, ou se você quiser tratar cabeçalhos por solicitação e autenticação de sessão de forma comum no Next.js, expanda para a forma completa a seguir.

As configurações padrão geram os arquivos abaixo.

apiUnionArrays.tsgera não apenas enums de schema OpenAPI, mas também arrays constantes readonly de enums de parâmetros de query, path, header e cookie, além de processar os items.enum de parâmetros de query array.

O Swagger pode ser do Springdoc, de outras ferramentas OpenAPI ou de arquivos escritos manualmente. Se você usar o endpoint funcional do WebFlux, webflux-fe-dev-assistantVocê também pode usar a forma de fornecer documentação Swagger.

Você pode especificar o endpoint do backend, o swagger.json a ser salvo, o caminho de saída de tipos/serviços e commonServiceFile de acordo com a estrutura do projeto.

Em ambientes onde não é possível receber documentos via HTTP, você pode usar junto com as mesmas opções de saída. generateSwaggerFromFilepara isso.

commonServiceFileé o caminho do arquivo que possui as funções callApi, callApiStream e o wrapper de cache que o serviço gerado importará. O gerador não é uma opção para criar ou sobrescrever este arquivo.

Um arquivo público designado como commonServiceFile, como rxjsHttpService.ts, é gerenciado diretamente pelo projeto. Os resultados abaixo de auto e @types/auto são regenerados quando o documento muda.

O nome do arquivo de serviço é determinado pelos dois primeiros segmentos da URL, e o nome da função é determinado a partir do terceiro segmento. Variáveis de caminho são incluídas no nome da função no formato By + PascalCase.

As chaves dos parâmetros de query do serviço gerado são params, as variáveis de caminho são path, e o corpo da solicitação é body. Dentro da função de geração, cada um é convertido em ServiceArguments de queryString, pathVariable e body.