Recursos e operações

Em Recursos e operaçoẽs, serão definidos todos os recursos da API com cada método HTTP desejado.

Além da inserção manual de recursos e operações, a tela Resources disponibiliza outras opções de inclusão de recursos. Para saber mais sobre elas, acesse Swagger Editor, Import WSDL e Create from Connector.

Criando um recurso

Para criar um recurso, basta clicar na opção Add Resource e preencher os dados necessários.

add resource

O campo Resource description não é obrigatório, mas sua inserção ajuda a identificar o recurso.

Após salvar o recurso, é necessário cadastrar uma operação para ele.

Não é obrigatório incluir um recurso quando você criar uma API — ele pode ser inserido posteriormente. No entanto, caso o recurso seja inserido quando da criação da API, a inclusão da operação torna-se obrigatória.

Para incluir uma operação, escolha o método (Method), insira o caminho (Path), e clique em Save operation, conforme mostra imagem a abaixo.

add operation

Você pode criar tantas operações quanto forem necessárias. Lembre-se de salvar cada operação (Save operation) antes de clicar em Save and next, que leva ao próximo passo.

  • Caso você não configure um método OPTIONS para o recurso, requisições preflight (com pré-envio) serão respondidas com os seguintes cabeçalhos:

    chave: valor

    access-control-allow-origin: *
    access-control-allow-methods: HEAD, DELETE, POST, GET, OPTIONS, PUT, PATCH

    Caso a requisição preflight contenha o cabeçalho access-control-request-headers, a resposta incluirá o seu conteúdo no cabeçalho de chave-valor access-control-allow-headers.

  • Caso você implemente o método OPTIONS no recurso, o fluxo que você definir será respeitado e a hierarquia de interceptors configurada será mantida.

Editando e excluindo um recurso

Após o cadastro dos recursos e operações, é possível editá-los e deletá-los, bem como criar novos itens, na mesma tela de criação.

Para posterior edição e exclusão, basta clicar sobre o card da API e você será direcionado para a tela de Overview, onde poderá realizar as alterações necessárias. Veja mais sobre Overview aqui.

Thanks for your feedback!
EDIT
How useful was this article to you?