Biblioteca de clientes do Serviço Do Azure Core para JavaScript – versão 1.9.2

Essa biblioteca deve ser usada principalmente no código gerado pelo AutoRest e o autorest.typescript.

Introdução

Ambientes com suporte no momento

• Versões LTS do Node.js
• Versões mais recentes do Safari, Chrome, Edge e Firefox.

Confira nossa política de suporte para mais detalhes.

Instalação

Este pacote é usado principalmente no código gerado e não deve ser consumido diretamente pelos usuários finais.

Principais conceitos

ServiceClient

Essa é a classe base comum para clientes gerados. Ele fornece os métodos sendOperationRequest e sendRequest.

sendRequest simplesmente faz uma solicitação HTTP usando um Pipeline (confira @azure/core-rest-pipeline para saber detalhes.)

sendOperationRequest é usado pelo código gerado para fazer uma solicitação usando um OperationSpec e OperationArguments. OperationSpec é uma conversão dos requisitos de solicitação do arquivo OpenAPI/Swagger que descreve o serviço.

createClientPipeline

Esse método é usado para criar uma instância de Pipeline personalizada com políticas extras que executam serialização e desserialização. A maior parte do trabalho está na conversão de solicitações na mensagem HTTP certa que um serviço espera e, depois, na conversão do conteúdo de resposta HTTP na forma de resposta descrita pelo arquivo de especificação OpenAPI do serviço.

Mappers/createSerializer

Mappers são usados para codificar e decodificar dados em cabeçalhos e corpos HTTP. Eles descrevem todos os campos de solicitação e resposta. Eles são referenciados por OperationSpecs.

O método createSerializer cria um Serializer que é usado para realizar a maior parte do trabalho transformando dados ao fazer uma solicitação ou processar uma resposta. Dado um corpus de Mappers e o OperationSpec apropriado, ele pode fabricar um objeto de solicitação HTTP de uma entrada fornecida pelo usuário ou converter um objeto de resposta HTTP em um formulário amigável ao usuário.

Próximas etapas

Você pode criar e executar os testes localmente executando rushx test. Explore a pasta de teste para ver o uso e o comportamento avançados das classes públicas.

Saiba mais sobre o AutoRest e a extensão autorest.typescript para gerar um cliente compatível com esse pacote.

Solução de problemas

Se você tiver problemas ao usar essa biblioteca, fique à vontade para registrar um problema.

Contribuição

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber como criar e testar o código.