Como consultar metadados com a API GraphQL

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, siga os passos descritos no guia Como rodar requisições da GraphQL no Postman utilizando a URL https://api.azionapi.net/metrics/graphql.

Depois, na caixa de código do Postman da requisição de GraphQL, adicione a seguinte Introspection Query:

query introspectionQuery {
 __type(name: "Query") {
   name
   description
   fields {
       name
       description
       type {
           ofType {
               fields {
                   name
                   description
                   type {
                       name
                      }
                  }
              }
          }
      }
  }
}

Envie sua requisição. Você receberá uma resposta semelhante a:

{
   "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": "Data Streamed Metrics dataset query by Minute, Hour and Day with aggregate options.",
          "type": {
            "ofType": {
              "fields": [
                {
                  "name": "ts",
                  "type": {
                    "name": "CustomDateTime"
                  }
                },
                {
                  "name": "configurationId",
                  "type": {
                    "name": "String"
                  }
                },
                {
                  "name": "endpointType",
                  "type": {
                    "name": "String"
                  }
               },
               {
          "name": "httpMetrics",
          "description": "Http Metrics dataset query by Minute, Hour and Day with aggregate options.",
          "type": {
            "ofType": {
              "fields": [
                {
                  "name": "ts",
                  "type": {
                    "name": "CustomDateTime"
                  }
                },
                {
                  "name": "configurationId",
                  "type": {
                    "name": "String"
                  }
                },
                {
                  "name": "host",
                  "type": {
                    "name": "String"
                  }
                },
                {
                  "name": "requestMethod",
                  "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 dados 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:

Contribuidores