Biblioteca de cliente do Serviço Azure Core para JavaScript – versão 1.9.2
Esta biblioteca destina-se principalmente a ser utilizada no código gerado pelo AutoRest e autorest.typescript
.
Introdução
Ambientes atualmente suportados
- Versões LTS do Node.js
- Versões mais recentes do Safari, Chrome, Edge e Firefox.
Veja a nossa política de suporte para obter mais detalhes.
Instalação
Este pacote é utilizado principalmente no código gerado e não se destina a ser consumido diretamente pelos utilizadores finais.
Conceitos-chave
ServiceClient
Esta é a classe base comum para clientes gerados. Fornece os métodos sendOperationRequest
e sendRequest
.
sendRequest
efetua simplesmente um pedido HTTP com um Pipeline
(consulte @azure/core-rest-pipeline
para obter detalhes.)
sendOperationRequest
é utilizado pelo código gerado para fazer um pedido com um OperationSpec
e OperationArguments
. Uma OperationSpec
é uma tradução dos requisitos de pedido do ficheiro OpenAPI/Swagger que descreve o serviço.
createClientPipeline
Este método é utilizado para criar uma Pipeline
instância personalizada com políticas adicionais que realizam serialização e desserialização. A maior parte do trabalho consiste em converter pedidos na mensagem HTTP correta que um serviço espera e, em seguida, converter o payload de resposta HTTP na forma de resposta descrita pelo ficheiro de especificação OpenAPI do serviço.
Mappers/createSerializer
Mapper
s são utilizados para codificar e descodificar dados em cabeçalhos e corpos HTTP. Descrevem todos os campos de pedido e resposta. São referenciados por OperationSpec
s.
O método createSerializer
cria um Serializer
que é utilizado para fazer a maior parte do trabalho transformando dados ao fazer um pedido ou processar uma resposta. Tendo em conta um corpus de Mapper
s e o adequado OperationSpec
, pode fabricar um objeto de pedido HTTP a partir de uma entrada fornecida pelo utilizador ou converter um objeto de resposta HTTP num formulário amigável para o utilizador.
Passos seguintes
Pode criar e executar os testes localmente ao executar rushx test
. Explore a pasta de teste para ver a utilização 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 sobre este pacote.
Resolução de problemas
Se tiver problemas ao utilizar esta biblioteca, não hesite em apresentar um problema.
Contribuir
Se 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