... | ... | @@ -6,23 +6,17 @@ Os dados são as informações contidas no banco de dados enquanto os meta dados |
|
|
|
|
|
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.
|
|
|
|
|
|
## Interface com o banco de dados
|
|
|
Para obter qualquer informação da API (dados ou metadados) duas informações são necessárias o **endereço base** e as **rotas**.
|
|
|
|
|
|
Um serviço que utiliza um banco de dados de alguma forma tem que recuperar esses dados. Existem ferramentas que podem ser utilizadas para simplicar o acesso mas em última instância o serviço manda uma consulta para o banco de dados, e esse responde.
|
|
|
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**.
|
|
|
|
|
|
O Blendb pode ser usado como uma ferramenta que facilita o acesso aos dados. Como toda ferramenta, ela é mais limitada do que enviar a consulta diretamente ao banco de dados, entretanto o processo de criar uma consulta é mais simples.
|
|
|
As **rotas** definem as operações que podem ser realizadas. Essas rotas definem a API.
|
|
|
|
|
|
Essa API abstrae o banco de dados, dessa forma o isolamento entre o Banco de dados e o serviço é maior e dessa forma é provavel que alterações no banco de dados tenham menor ou nenhum impacto sobre o serviço.
|
|
|
Para fazer uma requisição para a base da dados basta concatenar o **endereço base** com a **rota**.
|
|
|
|
|
|
O exemplo mais clássico é a criação de uma agregação para agilizar algumas consultas utilizadas recorrentemente no serviço. Todas as consultas deverão ser adaptadas para utilizar a nova agregação. Com o Blendb, como ele abstrae o banco de dados e esconde as agregações existentes, as consultas não precisariam ser modificadas.
|
|
|
Um exemplo, para obter as métricas da base **localhost:3000/v1** a requisição é feita para **localhost:3000/v1/metrics**
|
|
|
|
|
|
## Dados Abertos
|
|
|
|
|
|
A API oferece um serviço que pode ser facilmente disponibilizado através da Web para que pessoas e serviços do mundo todo acessem a base de dados de forma simples.
|
|
|
|
|
|
## Ambos
|
|
|
|
|
|
Entretanto em alguns casos, algumas informações da base de dados são extraídas realizando diversas requisições ao Blendb e combinando seus resultados. Quando esse tipo de indicador é necessário é recomendado utilizar um serviço auxiliar que faz diversas consultas e combina os resultados, além de expor a API do Blendb para consutas personalizadas.
|
|
|
A seguir é apresentado quais são as rotas utilizadas para obter dados e metadados e quais são os parametros que devem ser utilizados.
|
|
|
|
|
|
## [Home](/)
|
|
|
* [Introdução](api/introdução)
|
... | ... | |