Documentação de referência de referência da Azure Digital Twins Swagger
Importante
Foi lançada uma nova versão do serviço Azure Digital Twins. À luz das capacidades expandidas do novo serviço, o serviço original Azure Digital Twins (descrito neste conjunto de documentação) foi retirado.
Para ver a documentação do novo serviço, visite a Documentação ativa da Azure Digital Twins.
Cada instância Azure Digital Twins inclui a sua própria documentação de referência gerada automaticamente pela Swagger.
Swagger, ou OpenAPI, une informação complexa da API num recurso de referência interativa e agnóstico. A Swagger fornece material de referência crítico sobre o qual as cargas da JSON, métodos HTTP e pontos finais específicos para utilizar para realizar operações contra uma API.
Resumo de Swagger
A Swagger fornece um resumo interativo da sua API, que inclui:
- Informação sobre modelos de API e objetos.
- REST API pontos finais que especificam as cargas de pedidos, cabeçalhos, parâmetros, caminhos de contexto e métodos HTTP.
- Teste de funcionalidades da API.
- Informações de resposta de exemplo utilizadas para validar e confirmar respostas HTTP.
- Informação de código de erro.
A Swagger é uma ferramenta conveniente para ajudar no desenvolvimento e teste de chamadas feitas para as APIs de Gestão de Gémeos Digitais Azure.
Dica
É fornecida uma pré-visualização de swagger para demonstrar o conjunto de funcionalidades API. É hospedado em docs.westcentralus.azuresmartspaces.net/management/swagger.
Você pode aceder à sua própria documentação gerada pela API Swagger de Gestão em:
https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/swagger
| Name | Substituir |
|---|---|
| YOUR_INSTANCE_NAME | O nome da sua instância Azure Digital Twins |
| YOUR_LOCATION | Qual região de servidor o seu exemplo está hospedado em |
Material de referência
O material de referência swagger gerado automaticamente fornece uma visão geral rápida de conceitos importantes, pontos finais de API de gestão disponível, e uma descrição de cada modelo de objeto para ajudar no desenvolvimento e teste.
Um resumo conciso descreve a API.
Os modelos de objetos API de gestão também estão listados.
Pode selecionar cada modelo de objeto listado para um resumo mais detalhado dos atributos-chave.
Os modelos de objeto swagger gerados são convenientes para ler todos os objetos e APIs Azure Digital Twins disponíveis. Os desenvolvedores podem usar este recurso quando constroem soluções em Azure Digital Twins.
Resumo do ponto final
A Swagger também fornece uma visão geral completa de todos os pontos finais que compõem as APIs de Gestão.
Cada ponto final listado também inclui as informações de pedido necessárias, tais como:
- Parâmetros necessários.
- Tipos de dados de parâmetros necessários.
- Método HTTP para aceder ao recurso.
Selecione cada recurso para exibir os seus conteúdos adicionais para obter uma visão geral mais detalhada.
Use o Swagger para testar pontos finais
Uma das funcionalidades poderosas que a Swagger fornece é a capacidade de testar um ponto final da API diretamente através da documentação UI.
Depois de selecionar um ponto final específico, o botão Tentar será exibido.
Expanda esta secção para trazer campos de entrada para cada parâmetro necessário e opcional. Introduza os valores corretos e selecione Executar.
Depois de executar o teste, pode validar os dados de resposta.
Dados de resposta swagger
Cada ponto final listado também inclui dados do corpo de resposta para validar o seu desenvolvimento e testes. Estes exemplos incluem os códigos de estado e json para pedidos HTTP bem sucedidos.
Os exemplos também incluem códigos de erro para ajudar a depurar ou melhorar os testes falhados.
Autorização swagger OAuth 2.0
Nota
- O responsável pelo utilizador que criou o recurso Azure Digital Twins terá uma atribuição de funções de Administrador Espacial e será capaz de criar atribuições de funções adicionais para outros utilizadores. Esses utilizadores e as suas funções podem ser autorizados a chamar as APIs.
Siga os passos no Quickstart para criar e configurar uma aplicação Azure Ative Directory. Em alternativa, pode reutilizar um registo de aplicações existente.
Adicione o seguinte Redirecionar a URI ao seu registo de aplicações Azure Ative Directory:
https://YOUR_SWAGGER_URL/ui/oauth2-redirect-htmlName Substituir Exemplo YOUR_SWAGGER_URL O URL de documentação da API de Gestão REST encontrado no portal https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/swaggerSelecione a caixa de verificação detokens de acesso> implícito para permitir a utilização do fluxo de subvenção implícita OAuth 2.0. Selecione Configurar e, em seguida, Guardar.
Copie a identificação do Cliente da sua aplicação Azure Ative Directory.
Após a conclusão do registo do Diretório Ativo Azure:
Selecione o botão 'Autorizar' na sua página swagger.
Cole a identificação da aplicação no campo client_id .
Em seguida, será redirecionado para o seguinte modal de sucesso.
Para saber mais sobre os pedidos de testes interativos protegidos pela OAuth 2.0, leia a documentação oficial.
Passos seguintes
Para ler mais sobre os modelos de objetos Azure Digital Twins e o gráfico de inteligência espacial, leia os modelos de objetos Understand Azure Digital Twins.
Para aprender a autenticar com a sua API de Gestão, leia Autenticar com APIs.