Como consultar metadados com a GraphQL API
Metadados são informações relevantes sobre o escopo de dados da GraphQL API. Eles nos auxiliam a compreender melhor o relacionamento e a sua utilidade no processo de consulta.
Para consultar os metadados da GraphQL API, você deve realizar duas etapas: criar um personal token e executar uma requisição no Postman. Veja as próximas seções e siga os passos.
Criar um personal token
Para começar a usar a GraphQL API, você precisa criar um personal token para validar seu acesso:
- No Real-Time Manager (RTM), selecione Account menu > Personal Tokens.
- Preencha os campos para configurar seu personal token e clique no botão Create Token.
- Copie e salve seu personal token em um local seguro para utilizá-lo na próxima etapa.
Veja a documentação de Personal Tokens para mais informações sobre como criar um.
Como alternativa, você pode criar um token de curta duração através da Azion API.
Requisição de metadados com o Postman
Após criar o seu personal token, acesse o Postman e siga os próximos passos:
- No cabeçalho, clique no botão com o símbolo de + para criar uma nova requisição.
- Na aba Headers, clique em Bulk Edit e adicione o seguinte código, substituindo [TOKEN VALUE] com o valor do personal token que foi criado:
Authorization:Token [TOKEN VALUE]
Continue no Postman e crie o corpo da requisição:
- Selecione a aba Body.
- No canto superior esquerdo, clique na opção GET para abrir um menu suspenso.
- Selecione a opção POST.
- Na linha de opções, selecione a opção GraphQL.
- No espaço QUERY, adicione a IntrospectionQuery a seguir:
query introspectionQuery {
__type(name: "Query") {
name
description
fields {
name
description
type {
ofType {
fields {
name
description
type {
name
}
}
}
}
}
}
}
- No campo Enter URL or paste text, adicione a URL que será consultada:
https://api.azionapi.net/metrics/graphql - No canto superior direito, clique no botão Send.
Após executar a requisição, a GraphQL API retorna as seguintes informações:
{
"data": {
"__type": {
"name": "Query",
"description": "Class responsible for gathering the queries from the datasets and returning them in the form of graphql schema to the Django view.",
"fields": [
{
"name": "dataStreamedMetrics",
"description": "Query dataStreamed Aggregated with aggregate options.",
"type": {
"ofType": {
"fields": [
{
"name": "ts",
"type": {
"name": "CustomDateTime"
}
},
{
"name": "endpointType",
"type": {
"name": "String"
}
}
]
}
}
},
{
"name": "httpMetrics",
"description": "Query Http Aggregated with aggregate options.",
"type": {
"ofType": {
"fields": [
{
"name": "ts",
"type": {
"name": "CustomDateTime"
}
},
{
"name": "configurationId",
"type": {
"name": "String"
}
}
]
}
}
}
]
}
}
}
A API retorna os seguintes metadados:
- Conjuntos de dados disponíveis para consulta, como dataStreamedMetrics e httpMetrics.
- Campos que cada consulta por conjunto de dado dispõe para retornar.
- Respectivos tipos para os campos retornáveis, como Int, String, DateTime, e assim por diante.
Para saber mais sobre os conjuntos de dados disponíveis para consulta com a GraphQL API, visite a página de documentação.
Assista um tutorial sobre como consultar metadados com a GraphQL no canal do YouTube da Azion, com opção de ativar legendas em português:
Não encontrou o que procurava? Abra um ticket.