Biblioteca de cliente do Azure Core Service para JavaScript - versão 1.9.3
Esta biblioteca destina-se principalmente a ser usada em código gerado pelo AutoRest e autorest.typescript
.
Primeiros passos
Ambientes atualmente suportados
- versões LTS do Node.js
- Versões mais recentes do Safari, Chrome, Edge e Firefox.
Consulte o nosso de política de suporte para obter mais detalhes.
Instalação
Este pacote é usado principalmente no código gerado e não se destina a ser consumido diretamente pelos usuários finais.
Conceitos-chave
ServiceClient
Esta é 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
(consulte @azure/core-rest-pipeline
para obter detalhes).
sendOperationRequest
é usado pelo código gerado para fazer uma solicitação usando um OperationSpec
e OperationArguments
. Um OperationSpec
é uma traduçã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
que é 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 correta que um serviço espera e, em seguida, na conversão da carga útil de resposta HTTP na forma de resposta descrita pelo arquivo de especificação OpenAPI do serviço.
Mapeadores / createSerializer
Mapper
s 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 OperationSpec
s.
O método createSerializer
cria um Serializer
que é usado para fazer a maior parte do trabalho de transformação de dados ao fazer uma solicitação ou processar uma resposta. Dado um corpus de Mapper
s e a OperationSpec
apropriada, ele pode fabricar um objeto de solicitação HTTP a partir de uma entrada fornecida pelo usuário ou converter um objeto de resposta HTTP em um formulário amigável.
Próximos passos
Você pode criar e executar os testes localmente executando rushx test
. Explore a pasta de teste para ver o uso avançado e o comportamento das classes públicas.
Saiba mais sobre AutoRest e a extensão autorest.typescript para gerar um cliente compatível sobre este pacote.
Solução de problemas
Se você tiver problemas ao usar esta biblioteca, sinta-se à vontade para registrar um problema.
Contribuição
Se você quiser contribuir para esta biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.
Azure SDK for JavaScript