Resources de uma API

Em resources será definido todos os recursos da API com cada método http desejado.

Além da inserção manual de recursos e operações, a tela de Resources disponibiliza outras opções de inclusão de recursos como a edição pelo Swagger Editor, importação pelo IMPORT WSDL e importação diretamente por um banco de dados pelo IMPORT FROM DB

A opção de ativação de cache também está disponível para configuração no flow para cada operação.

Criando um resource

Para criar um resource, basta clicar na opção de ADD RESOURCE e preencher os dados necessários:

O campo "Resource description" não é um campo obrigatório, mas sua inserção é benéfica para melhor identificação do recurso.

Ainda em Resource, é possível selecionar um database. Neste caso o recurso passa a ser um recurso de BAAS.

O campo "Database" é obrigatório se o campo "Add Database" for marcado, caso contrário é necessário informar o "Resource name". Para selecionar um Database primeiramente deve ter sido realizado o cadastro de um BAAS Database.

Após o cadastro de Resource é necessário cadastrar uma operação para este recurso. Lembrando que o recurso não é obrigatório na criação de uma API, podendo ser inserido posteriormente. Caso o recurso seja inserido na criação da API, a inclusão da operação torna-se obrigatória.

Basta escolher o "Method", o "Path" e clicar em "SAVE OPERATION", conforme mostra imagem abaixo:

Caso queira gerar uma requisição assíncrona, é necessário marcar a opção Async, disponível na criação da operação.

Ao marcar a opção "Async " será disponibilizada uma janela para inserção das Operation URLs:

Se para um determinado Resource for selecionado um Database, em todas as suas operações deverá ser informada uma query ou procedure correspondente ao recurso que se deseja ter acesso. Dessa forma o recurso torna-se um Resource from BAAS.

O campo "Query" torna-se obrigatório no cadastro de Operation quando for selecionado um Database, e todos as operações ficam vinculadas ao mesmo Database.

Editando e excluindo um resource

Após o cadastro dos resources e operations é possível editar, deletar, criar novos resources e operations na mesma tela de criação.

Para posterior edição e exclusão, basta clicar sobre o card que será direcionado para a tela de Overview, onde será possível realizar as alterações necessárias.

Tem mais dúvidas? Envie uma solicitação

Comentários

Powered by Zendesk