{"id":6669,"date":"2019-04-15T07:26:38","date_gmt":"2019-04-15T14:26:38","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=6669"},"modified":"2019-05-17T12:35:20","modified_gmt":"2019-05-17T19:35:20","slug":"generating-couchbase-api-dreamfactory","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/pt\/generating-couchbase-api-dreamfactory\/","title":{"rendered":"Gera\u00e7\u00e3o de APIs do Couchbase com o DreamFactory"},"content":{"rendered":"

Esta \u00e9 uma postagem de convidado escrita por W. Jason Gilmore (https:\/\/www.wjgilmore.com<\/a>), CTO da DreamFactory, Inc., uma plataforma de automa\u00e7\u00e3o e gerenciamento de APIs de c\u00f3digo aberto. Antes de ingressar na DreamFactory, ele passou grande parte de sua carreira como consultor e desenvolvedor, ajudando equipes de todo o mundo a criar solu\u00e7\u00f5es de software incr\u00edveis. Jason \u00e9 um escritor prol\u00edfico no assunto de tecnologias da Web, com quase uma d\u00fazia de livros e mais de 300 artigos em seu curr\u00edculo. Ele atua como consultor t\u00e9cnico especial para v\u00e1rias startups sediadas em Ohio e Nova York.<\/em><\/p>\r\n\r\n\r\n\r\n

\"Jason<\/figure>\r\n\r\n\r\n\r\n

As organiza\u00e7\u00f5es modernas est\u00e3o sob enorme press\u00e3o para processar e incorporar dados de forma eficiente em todas as iniciativas. De fato, a \u00eanfase dada \u00e0 extra\u00e7\u00e3o, \u00e0 compila\u00e7\u00e3o, \u00e0 an\u00e1lise e \u00e0 dissemina\u00e7\u00e3o de informa\u00e7\u00f5es \u00e9 tanta que um campo de estudo totalmente novo, conhecido como ci\u00eancia de dados<\/strong> surgiu para dar sentido a tudo isso (para aqueles que est\u00e3o pensando que isso soa desconfiadamente acad\u00eamico, observe que a Harvard Business Review chamou a ci\u00eancia de dados de O trabalho mais sexy do s\u00e9culo XXI<\/a>.<\/p>\r\n\r\n\r\n\r\n

A necessidade de APIs<\/h2>\r\n\r\n\r\n\r\n

Al\u00e9m de formalizar o processo de gerenciamento de dados, as equipes de TI t\u00eam adotado cada vez mais ambientes de bancos de dados heterog\u00eaneos e desenvolvimento orientado por APIs, em um esfor\u00e7o para garantir que os dados possam ser ingeridos, processados e distribu\u00eddos com o m\u00ednimo de atrito. J\u00e1 se foi o tempo em que uma organiza\u00e7\u00e3o inteira padronizava um determinado fornecedor de banco de dados; em vez disso, agora \u00e9 comum que as empresas adotem uma mistura de solu\u00e7\u00f5es SQL e NoSQL comerciais e de c\u00f3digo aberto.<\/p>\r\n\r\n\r\n\r\n

\u00c9 claro que deve haver uma maneira sensata de gerenciar os dados \u00e0 medida que eles fluem por esses bancos de dados, e \u00e9 a\u00ed que entram as APIs. Como os bancos de dados geralmente precisam ser consultados em v\u00e1rios aplicativos (iOS, Web etc.), nos \u00faltimos anos os desenvolvedores t\u00eam evitado bibliotecas espec\u00edficas de aplicativos, preferindo as APIs. Ao criar e se conectar a uma API uniforme, os desenvolvedores podem se concentrar no aplicativo em si, em vez de se preocuparem com o encanamento relacionado ao banco de dados.<\/p>\r\n\r\n\r\n\r\n

Entrar no DreamFactory<\/h2>\r\n\r\n\r\n\r\n

Ou, pelo menos, essa \u00e9 a ideia. A realidade \u00e9 que a cria\u00e7\u00e3o e a manuten\u00e7\u00e3o de uma API de banco de dados \u00e9 um esfor\u00e7o extraordinariamente demorado e caro. Embora uma equipe experiente possa criar uma interface de API CRUD em algumas semanas, ela geralmente n\u00e3o leva em considera\u00e7\u00e3o os v\u00e1rios recursos adicionais necess\u00e1rios para o gerenciamento da API. Recursos como autentica\u00e7\u00e3o e autoriza\u00e7\u00e3o, limita\u00e7\u00e3o de volume de solicita\u00e7\u00f5es, armazenamento em cache e registro em log geralmente n\u00e3o s\u00e3o considerados no planejamento de uma API, e descobrir como implementar esses recursos de forma fragmentada pode ser extremamente dif\u00edcil e caro.<\/p>\r\n\r\n\r\n\r\n

Muitas organiza\u00e7\u00f5es evitam essas dores de cabe\u00e7a adotando um Plataforma de gerenciamento de API<\/strong>. Uma solu\u00e7\u00e3o desse tipo particularmente popular \u00e9 DreamFactory<\/a>. Ele n\u00e3o s\u00f3 \u00e9 de c\u00f3digo aberto (vers\u00f5es comerciais que oferecem recursos avan\u00e7ados tamb\u00e9m est\u00e3o dispon\u00edveis), mas tamb\u00e9m inclui suporte nativo para o Couchbase! Nesta postagem, voc\u00ea aprender\u00e1 como gerar uma API REST do Couchbase usando o DreamFactory em apenas alguns minutos e, em seguida, bloquear o acesso \u00e0 API usando o recurso de gerenciamento de fun\u00e7\u00f5es do DreamFactory.<\/p>\r\n\r\n\r\n\r\n

Apresentando o DreamFactory<\/h2>\r\n\r\n\r\n\r\n

DreamFactory<\/a> \u00e9 uma estrutura de automa\u00e7\u00e3o e gerenciamento de APIs usada por dezenas de milhares de organiza\u00e7\u00f5es em todo o mundo. Embora sua popularidade decorra em grande parte da capacidade de gerar APIs seguras, documentadas e com todos os recursos para uma variedade de bancos de dados SQL e NoSQL sem necessidade de codifica\u00e7\u00e3o, o DreamFactory, na verdade, oferece suporte a milhares de fontes de dados e servi\u00e7os de terceiros, incluindo provedores de entrega de e-mail, servi\u00e7os de notifica\u00e7\u00e3o m\u00f3vel, incluindo AWS SNS, Apple e GCM Push, e para converter servi\u00e7os SOAP em REST.<\/p>\r\n\r\n\r\n\r\n

O DreamFactory \u00e9 compat\u00edvel com um total de 18 bancos de dados, incluindo MySQL, Oracle, Microsoft SQL Server e... Couchbase! A gera\u00e7\u00e3o de uma API \u00e9 muito simples, exigindo apenas o fornecimento de um nome de API desejado e credenciais do servidor Couchbase. Para criar uma API, voc\u00ea come\u00e7ar\u00e1 fazendo login na interface de administra\u00e7\u00e3o da Web do DreamFactory. Voc\u00ea poder\u00e1 acessar os principais recursos do DreamFactory por meio da barra de navega\u00e7\u00e3o:<\/p>\r\n\r\n\r\n\r\n

\"DreamFactory<\/figure>\r\n\r\n\r\n\r\n

Crie o servi\u00e7o clicando em Servi\u00e7os<\/code> ent\u00e3o Criar<\/code>e, em seguida, escolha Couchbase<\/code> do Banco de dados<\/code> categoria:<\/p>\r\n\r\n\r\n\r\n

\"Select<\/figure>\r\n\r\n\r\n\r\n

Em seguida, voc\u00ea escolher\u00e1 um nome de API e definir\u00e1 um r\u00f3tulo e uma descri\u00e7\u00e3o. O nome \u00e9 particularmente importante, pois, como voc\u00ea ver\u00e1, ele servir\u00e1 como uma esp\u00e9cie de espa\u00e7o de nome para a API gerada. O r\u00f3tulo e a descri\u00e7\u00e3o s\u00e3o apenas para fins de refer\u00eancia na interface de administra\u00e7\u00e3o:<\/p>\r\n\r\n\r\n\r\n

\"Couchbase<\/figure>\r\n\r\n\r\n\r\n

Depois de preencher esses campos, clique no bot\u00e3o Configura\u00e7\u00e3o<\/code> e forne\u00e7a suas credenciais do Couchbase:<\/p>\r\n\r\n\r\n\r\n

\"Completed<\/figure>\r\n\r\n\r\n\r\n

Al\u00e9m do Anfitri\u00e3o<\/code>, Porto<\/code>, Nome de usu\u00e1rio<\/code> e Senha<\/code> opcionalmente, \u00e9 poss\u00edvel limitar o n\u00famero de registros retornados por um campo OBTER<\/code> e ativar o cache de dados por um per\u00edodo de tempo definido. Para os fins deste tutorial, deixarei essas op\u00e7\u00f5es intocadas e apenas gerarei a API pressionando o bot\u00e3o Salvar<\/code> bot\u00e3o.<\/p>\r\n\r\n\r\n\r\n

Interagindo com a API<\/h2>\r\n\r\n\r\n\r\n

Depois que a API tiver sido gerada, voc\u00ea poder\u00e1 navegar at\u00e9 a se\u00e7\u00e3o Documentos da API<\/code> para fazer experi\u00eancias com ela. O DreamFactory gera documenta\u00e7\u00e3o Swagger para cada API, e os administradores podem fornecer aos usu\u00e1rios acesso restrito a essa documenta\u00e7\u00e3o. Selecione a nova API e voc\u00ea ver\u00e1 uma lista de todos os pontos de extremidade dispon\u00edveis:<\/p>\r\n\r\n\r\n\r\n

\"API<\/figure>\r\n\r\n\r\n\r\n

Escolha o GET \/_schema<\/code> e pressione a tecla Experimente<\/code> bot\u00e3o. Como a documenta\u00e7\u00e3o do Swagger \u00e9 interativa, voc\u00ea pode aprender como a API funciona sem ter que ir direto para o c\u00f3digo, o que pode reduzir bastante a frustra\u00e7\u00e3o. Pressionando Experimente<\/code> habilitar\u00e1 os v\u00e1rios campos de par\u00e2metros associados a esse ponto de extremidade:<\/p>\r\n\r\n\r\n\r\n

\"Detailed<\/figure>\r\n\r\n\r\n\r\n

OBSERVA\u00c7\u00c3O: devido \u00e0 amplitude dos bancos de dados suportados e \u00e0 import\u00e2ncia dada ao fornecimento de uma interface de API de banco de dados uniforme, independentemente do tipo de banco de dados subjacente, o DreamFactory usa termos gen\u00e9ricos para se referir a estruturas relacionadas a bancos de dados. Logicamente, esses termos nem sempre mapeiam exatamente a terminologia espec\u00edfica do banco de dados. Por exemplo, o Couchbase usa o termo balde<\/strong> para representar um banco de dados, enquanto o DreamFactory usa o termo gen\u00e9rico esquema<\/strong> para essa representa\u00e7\u00e3o.<\/em><\/p>\r\n\r\n\r\n\r\n

Pressione o bot\u00e3o Executar<\/code> e o ponto de extremidade da API ser\u00e1 consultado, retornando todos os buckets dispon\u00edveis. Os usu\u00e1rios do Couchbase estar\u00e3o familiarizados com a fun\u00e7\u00e3o amostra de viagem<\/code> retornado na resposta a seguir:<\/p>\r\n\r\n\r\n\r\n

\"Example<\/figure>\r\n\r\n\r\n\r\n

Acesso a dados da API<\/h2>\r\n\r\n\r\n\r\n

Em seguida, role para baixo at\u00e9 a se\u00e7\u00e3o GET \/_table\/{table_name}<\/code> para recuperar registros (documentos) do amostra de viagem<\/code> bucket. O processo para fazer isso \u00e9 semelhante ao usado para recuperar os buckets; voc\u00ea selecionar\u00e1 o endpoint, pressionar\u00e1 Experimente<\/code>e, em seguida, insira os par\u00e2metros de endpoint de API desejados. Como voc\u00ea pode ver na captura de tela abaixo, esse endpoint \u00e9 compat\u00edvel com v\u00e1rios par\u00e2metros:<\/p>\r\n\r\n\r\n\r\n

\"API<\/figure>\r\n\r\n\r\n\r\n

Quando se trata de selecionar registros, o DreamFactory oferece suporte a tudo o que voc\u00ea normalmente faria ao consultar um banco de dados. \u00c9 poss\u00edvel selecionar campos espec\u00edficos, unir tabelas, filtrar registros, aplicar limites e deslocamentos, e assim por diante. Para este exemplo, vamos manter a simplicidade e rolar para baixo at\u00e9 a parte inferior da lista de par\u00e2metros e inserir amostra de viagem<\/code> no nome_da_tabela<\/code> par\u00e2metro. Pressione Executar<\/code> e voc\u00ea ver\u00e1 os seguintes resultados:<\/p>\r\n\r\n\r\n\r\n

\"Couchbase<\/figure>\r\n\r\n\r\n\r\n

Gera\u00e7\u00e3o de uma chave de API restrita<\/h2>\r\n\r\n\r\n\r\n

A interface API Docs \u00e9 excelente para saber mais sobre o funcionamento de uma API, mas \u00e9 inevit\u00e1vel que voc\u00ea queira come\u00e7ar a consultar a API em um aplicativo da Web ou m\u00f3vel. Para isso, voc\u00ea dever\u00e1 primeiro gerar um aplicativo Chave da API<\/strong>. Isso ocorre porque o DreamFactory n\u00e3o suporta o conceito de uma API p\u00fablica; todas as APIs s\u00e3o protegidas, no m\u00ednimo, por uma chave de API. Al\u00e9m disso, cada chave de API \u00e9 mapeada para uma fun\u00e7\u00e3o<\/strong>. As fun\u00e7\u00f5es do DreamFactory determinam o que um cliente de posse de uma chave de API pode fazer em conjunto com a API. Por exemplo, voc\u00ea pode criar uma fun\u00e7\u00e3o que seja somente de leitura, ou que permita apenas o acesso a uma tabela espec\u00edfica do banco de dados, ou que possa inserir registros em uma tabela, mas ler registros de outra tabela.<\/p>\r\n\r\n\r\n\r\n

Para criar uma fun\u00e7\u00e3o, navegue at\u00e9 a se\u00e7\u00e3o Fun\u00e7\u00f5es<\/code> e pressione Criar<\/code>. Voc\u00ea atribuir\u00e1 um nome e uma descri\u00e7\u00e3o \u00e0 fun\u00e7\u00e3o e, em seguida, clicar\u00e1 no bot\u00e3o Acesso<\/code> aba. \u00c9 aqui que a m\u00e1gica acontece. Na captura de tela a seguir, voc\u00ea ver\u00e1 que selecionei a guia couchbase<\/code> API (servi\u00e7o) e definir Componente<\/code> para _table\/travel-sample\/*<\/code>ou seja, a fun\u00e7\u00e3o s\u00f3 pode acessar esse conjunto de dados espec\u00edfico. Al\u00e9m disso, defini Acesso<\/code> para OBTER<\/code>o que significa que essa ser\u00e1 uma fun\u00e7\u00e3o somente de leitura:<\/p>\r\n\r\n\r\n\r\n

\"Create<\/figure>\r\n\r\n\r\n\r\n

H\u00e1 alguns outros recursos interessantes aqui, mas, por uma quest\u00e3o de brevidade, sugiro apenas pressionar Salvar<\/code> para gerar a fun\u00e7\u00e3o.<\/p>\r\n\r\n\r\n\r\n

Em seguida, clique no bot\u00e3o Aplicativos<\/code> para gerar uma chave de API. Pressione o bot\u00e3o Criar<\/code> e voc\u00ea ver\u00e1 a seguinte interface:<\/p>\r\n\r\n\r\n\r\n

\"Create<\/figure>\r\n\r\n\r\n\r\n

Aqui voc\u00ea fornecer\u00e1 um nome e uma descri\u00e7\u00e3o do aplicativo. Voc\u00ea tamb\u00e9m escolher\u00e1 uma fun\u00e7\u00e3o para essa chave de API e, neste exemplo, selecionei a rec\u00e9m-gerada couchbase<\/code> fun\u00e7\u00e3o. Por fim, para o Localiza\u00e7\u00e3o do aplicativo<\/code> Eu selecionei N\u00e3o \u00e9 necess\u00e1rio armazenamento<\/code> porque estarei me conectando \u00e0 API de um local remoto, como um aplicativo da Web. Pressione Salvar<\/code> e voc\u00ea retornar\u00e1 \u00e0 listagem de chaves do aplicativo:<\/p>\r\n\r\n\r\n\r\n

\"Create<\/figure>\r\n\r\n\r\n\r\n

Parab\u00e9ns, voc\u00ea acabou de criar uma chave de API restrita somente para leitura! Agora vamos usar essa chave para falar com o bucket do Couchbase.<\/p>\r\n\r\n\r\n\r\n

Conectando-se \u00e0 sua API<\/h2>\r\n\r\n\r\n\r\n

Com sua chave de API em m\u00e3os, \u00e9 hora de interagir com a API de fora da interface do DreamFactory. Para os fins deste exemplo, usarei o Cliente REST da Insomnia<\/a> no entanto, voc\u00ea pode usar Carteiro<\/a>Outro cliente de API, ou certamente pode criar uma interface simples para a Web ou para o iPhone. Na captura de tela a seguir, consultei a \/api\/v2\/couchbase\/_table\/travel-sample<\/code> e, no lado direito da interface, voc\u00ea pode ver os resultados:<\/p>\r\n\r\n\r\n\r\n

\"Using<\/figure>\r\n\r\n\r\n\r\n

De particular import\u00e2ncia aqui \u00e9 o X-DreamFactory-Api-Key<\/code> header! \u00c9 aqui que a chave da API \u00e9 fornecida. Deixar de fornecer a chave resultar\u00e1 em uma mensagem 400<\/code> com uma mensagem de erro referente a uma chave ausente. Al\u00e9m disso, se essa chave tentar acessar uma tabela restrita ou executar uma a\u00e7\u00e3o (inserir, atualizar etc.) que n\u00e3o tenha sido expressamente permitida na defini\u00e7\u00e3o da fun\u00e7\u00e3o, ser\u00e1 gerado um 401<\/code> um c\u00f3digo de status n\u00e3o autorizado ser\u00e1 retornado.<\/p>\r\n\r\n\r\n\r\n

Recursos<\/h2>\r\n\r\n\r\n\r\n

Esperamos que esta introdu\u00e7\u00e3o ao DreamFactory tenha feito com que sua mente se concentre na rapidez com que voc\u00ea pode come\u00e7ar a criar aplicativos com base no Couchbase. Se voc\u00ea estiver interessado em saber mais, os recursos a seguir devem ser \u00fateis:<\/p>\r\n\r\n\r\n\r\n