Como usar o Swagger?

Planos que dão suporte ao acesso às configurações de token de API no portal da base de dados de conhecimento

Swagger é uma linguagem de descrição de interface que descreve APIs RESTful expressas usando JSON. Ele permite que você crie documentação de API interativa, legível por máquina e por humanos. Ele ajuda você a visualizar e interagir com os recursos da API sem nenhuma lógica de implementação. É um aplicativo baseado na web.

Site de documentação do Swagger

1. Abra o site de documentação do Swagger.

2. Para autenticar a documentação, clique em Autorizar.
   O painel Autorizações disponíveis será exibido.

3. Insira o token da API no campo Valor .

   NOTA

   Você pode selecionar um token existente ou gerar um novo token de acordo com sua necessidade. Para gerar um novo token, siga as etapas abaixo

   • Vá para Configurações > tokens de API no portal da Base de Dados de Conhecimento.

   • Digite um nome para o token de API em Inserir nome do token.

   • Selecione o(s) método(s) HTTP necessário(s). Você tem quatro métodos em Métodos(s) permitido(s): GET, PUT, POST e DELETE.

   • Você só pode usar o token gerado para o(s) método(s) selecionado(s). Ele não pode ser usado para executar outros métodos.

   • Clique em Copiar para copiar o token de API.

4. Clique no botão Autorizar .

5. Uma vez feito isso, clique no botão Fechar .
   A autorização é feita com sucesso.

   

   NOTA

   Se você quiser mudar para um token diferente, clique em Autorizar > Logout > insira seu token de API > Autorizar > Fechar.

OBTER

• O método GET é usado para recuperar informações.

• Abaixo está um exemplo de ação GET , para recuperar todos os registros sobre a conta da equipe.

1. Preencha os campos marcados e clique no botão Executar .

   As informações sobre a conta da equipe estarão disponíveis na seção Respostas .

POSTAR

• O método POST é usado para adicionar um item.

• Abaixo está um exemplo de uma ação POST para adicionar uma conta de equipe a um projeto.

1. Você deve adicionar as informações da conta da equipe, como email_id, first_name e last_name para adicionar um usuário ao projeto.
   A conta da equipe será adicionada ao projeto.

2. Clique no botão Executar .
   A adição da conta da equipe será bem-sucedida se o status for 200 e o sucesso for verdadeiro.

PÔR

• O método PUT é usado para atualizar um item existente.

• Abaixo está um exemplo de ação PUT para atualizar uma função de usuário no projeto.

1. Insira o userId no campo marcado.

2. Atualize a função de usuário com o número mencionado para a sintaxe da função de usuário. Os números para as respectivas funções são os seguintes:

   • 1 → Administrador

   • 2 Editor →

   • 3 → redator de rascunho

   • 4 → Leitor

   • 7 → Proprietário

3. Feito isso, clique no botão Executar .

   A atualização do usuário será bem-sucedida se o status for 200 e o sucesso for verdadeiro.

EXCLUIR

• O método DELETE é usado para excluir um item.

• Abaixo está um exemplo de uma ação DELETE para excluir um userId.

1. Insira o userId no campo marcado.

2. Feito isso, clique no botão Executar .
   Se o status for 200 e o sucesso for verdadeiro, o userId será excluído com êxito.

   

NOTA

É obrigatório inserir o conteúdo no campo marcado como *obrigatório.

 Para obter mais informações, consulte os seguintes blogs

1. Guia definitivo para criar uma documentação de API com exemplos

2. Feature spotlight – API in Document360

   ---

   Perguntas frequentes

   O que devo fazer se a atualização da página encerrar minha sessão?

   Se você atualizar a página, a sessão poderá terminar e você terá que se autenticar novamente. Siga as etapas fornecidas para autenticação.

   Como devo formatar campos que exigem um caractere específico?

   Você deve usar um sublinhado sempre que necessário. Por exemplo, use "email_id" em vez de "ID de e-mail". O uso de espaços resultará em um erro.