Como consultar metadados com a API GraphQL
Metadados são informações relevantes sobre o escopo de dados da API GraphQL. Eles nos auxiliam a compreender melhor o relacionamento e a sua utilidade no processo de consulta.
Para consultar os metadados da API GraphQL, você vai realizar duas etapas: criar um Personal Token e executar sua solicitação no Postman. Veja as próximas seções e siga os passos.
Criar Personal Tokens
Para começar a usar a API GraphQL, você precisa criar um Personal Token a fim de validar seu acesso:
- No Real-Time Manager (RTM), selecione Account Menu > Personal Tokens.
- Salve seu Personal Token em um local seguro para utilizá-lo nas próximas etapas.
Veja a página de documentação para mais informações sobre o processo de criação de Personal Tokens.
Como alternativa, você pode criar um Personal Token de curta duração através da Azion API.
Solicitar metadados com o Postman
Após criar o seu Personal Token, vá para o Postman e siga os próximos passos:
- Na parte superior do Postman, clique no botão com o símbolo de + para criar um nova requisição.
- Vá até a aba Headers, na parte superior, clique em Bulk Edit e adicione o seguinte código, juntamente com o valor do Personal Token que foi criado:
Authorization:Token [TOKEN VALUE]
Após criar o Headers com o token, siga na mesma tela do Postman para criar o corpo da requisição:
- No canto superior esquerdo, clique na opção GET para abrir a lista suspensa.
- Selecione a opção POST.
- Selecione a aba Body, na linha de opções, e selecione a opção GraphQL.
- No espaço QUERY, adicione a seguinte IntrospectionQuery:
query introspectionQuery {
__type(name: "Query") {
name
description
fields {
name
description
type {
ofType {
fields {
name
description
type {
name
}
}
}
}
}
}
}
- No campo Enter request URL, adicione a URL da API GraphQL 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 API GraphQL 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:
- Datasets disponíveis para consulta, como dataStreamedMetrics e httpMetrics.
- Campos que cada consulta por dataset dispõe para retornar.
- Respectivos tipos para os campos retornáveis, como Int, String, Datetime, e assim por diante.
Para saber mais sobre os datasets disponíveis para consulta com a API GraphQL, visite a página de documentação.
Não encontrou o que procurava? Abra um ticket.