---
title: "Como usar o Swagger"
slug: "how-to-use-swagger"
updated: 2026-07-01T04:57:31Z
published: 2026-07-01T04:57:31Z
canonical: "docs.document360.com/how-to-use-swagger"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.document360.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Como usar o Swagger

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

---

## Site de documentação Swagger

1. Abra o [site de documentação do Swagger](https://apihub.document360.io/).
2. Para autenticar a documentação, clique **em Autorizar**. O painel **de Autorizações Disponíveis** será exibido.
3. Insira o token API no campo **Valor** .

> [!NOTE]
> NOTA
> 
> Você pode selecionar um token existente ou gerar um novo token conforme sua necessidade. Para gerar um novo token, siga os passos abaixo
> 
> - Navegue até Configurações () na barra de navegação à esquerda do portal da base de conhecimento.
> - No painel de navegação à esquerda, navegue até **Portal da base de conhecimento** > **Tokens da API**.
> - Digite um nome para o token API no **nome Enter token**.
> - Selecione o(s) método(s) HTTP necessário(s). Você tem quatro métodos em **(s) método(s) permitido(s**): **GET**, **PUT**, **POST** e **DELETE**.
> - Você só pode usar o token gerado para o(s) método(s) selecionado(s). Não pode ser usado para realizar outros métodos.
> - Clique **em Copiar** para copiar o token da API.
4. Clique no **botão Autorizar** .
5. Depois de terminar, clique no **botão Fechar** . A autorização é feita com sucesso.

![Image showing authorize panel in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/17_ScreenShot-Swagger.png)

> [!NOTE]
> NOTA
> 
> Se você deseja mudar para um token diferente, clique **em Autorizar** > **Logout** > insira seu **token API** > **Autorizar** > **Fechar**.

### OBTER

- O método **GET** é usado para recuperar informações.
- Abaixo está um exemplo da ação **GET** , para recuperar todos os registros sobre o usuário.

![Image showing GET action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/12_ScreenShot-Swagger_Get.png)

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

As informações sobre o usuário estarão disponíveis na seção **Respostas** .

![Image showing GET action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/13_ScreenShot-Swagger_Get.png)

### POSTAR

- O método **POST** é usado para adicionar um item.
- Abaixo está um exemplo de ação **POST** , para adicionar um usuário a um projeto.

![Image showing POST action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/14_ScreenShot-Swagger_Post.png)

1. Você deve adicionar as informações do usuário, como email_id, first_name e last_name para adicionar um usuário ao projeto. O usuário será adicionado ao projeto.
2. Clique no **botão Executar** . A adição do usuário será bem-sucedida se o status for 200 e o sucesso for verdadeiro.

### PUT

- O método **PUT** é usado para atualizar um item existente.
- Abaixo está um exemplo de ação **PUT** , para atualizar um papel de usuário no projeto.

![Image showing PUT action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/15_ScreenShot-Swagger_Put.png)

1. Insira o **userId** no campo marcado.
2. Atualize o papel do usuário com o número mencionado para a sintaxe do papel do usuário. Os números para os respectivos papéis são os seguintes:
  - 1 → Administrador
  - 2 → Editor
  - 3 → Redator de Rascunho
  - 4 → Leitor
  - 7 → Proprietário
3. Depois de terminar, clique no botão **Executar** .

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

### DELETE

- O método **DELETE** é usado para excluir um item.
- Abaixo está um exemplo de ação **de DELETAÇÃO** , para excluir um **userId**.

1. Insira o **userId** no campo marcado.
2. Depois de terminar, clique no botão **Executar** . Se o status for 200 e o sucesso for verdadeiro, o **userID** será deletado com sucesso.

![Image showing DELETE action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/16_ScreenShot-Swagger_Delete.png)

> [!NOTE]
> NOTA
> 
> É obrigatório inserir o conteúdo no campo marcado como ***obrigatório**.

Para mais informações, consulte os seguintes blogs

1. [Guia definitivo para criar uma documentação de API com exemplos](https://document360.com/blog/api-documentation/)
2. [Destaque de recursos – API no Document360](https://www.google.com/search?q=Feature+spotlight+%E2%80%93+API+in+Document360&rlz=1C1CHBD_enIN1119IN1119&oq=Feature+spotlight+%E2%80%93+API+in+Document360&gs_lcrp=EgZjaHJvbWUyBggAEEUYOTIGCAEQRRg80gEHNDI5ajBqN6gCALACAA&sourceid=chrome&ie=UTF-8)

---

### Perguntas frequentes

#### O que devo fazer se atualizar a página encerrar minha sessão?

Se você atualizar a página, a sessão pode terminar e você terá que autenticar novamente. Siga os passos fornecidos para a 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 "endereço de e-mail". Usar espaços resultará em um erro.