O propósito dessa API é simples, facilitar a geração de consultas. Tanto seres humanos como outros serviços podem se aproveitar dessa facilidade.
A API disponibiliza 2 tipos de informações, dados e metadados.
Os dados são as informações contidas no banco de dados enquanto os meta dados são informações auxiliares para informar o usuário quais dados estão disponíveis.
Os metadados são utilizados por humanos para preparar um consulta. Em outras palavras saber o que ela vai retornar. Em geral um serviço apenas requisita metadados para redirecionar para um usuário humano.
Para obter qualquer informação da API (dados ou metadados) duas informações são necessárias o endereço base e as rotas.
O endereço base representa a base de dados. Nada mais é do que uma URL. Uma base pública provavelmente informará qual é a URL base. Um exemplo de endereço base para uma abse pública seria blendb.c3sl.ufpr.br/api/v1 . Uma instalação local poderia ser localhost:3000/v1.
As rotas definem as operações que podem ser realizadas. Essas rotas definem a API.
Para fazer uma requisição para a base da dados basta concatenar o endereço base com a rota.
Um exemplo, para obter as métricas da base localhost:3000/v1 a requisição é feita para localhost:3000/v1/metrics
A seguir é apresentado quais são as rotas utilizadas para obter dados e metadados e quais são os parametros que devem ser utilizados.