Criando um Endpoint

Endpoints são os blocos fundamentais das APIs no Apidog. Este guia apresenta como criar e especificar endpoints, ajudando você a definir suas especificações de API de forma eficaz.

O que é um Endpoint?

Um endpoint representa uma única operação de API que pode ser invocada via HTTP. Cada endpoint consiste em:

Componente	Descrição	Exemplo
Método HTTP	A ação a ser executada	`GET`, `POST`, `PUT`, `DELETE`
Caminho	O caminho da URL relativo à URL base	`/users/{id}`
Parâmetros	Parâmetros de caminho, consulta, cabeçalho ou corpo	`id` (parâmetro de caminho)
Corpo da Requisição	Dados enviados com a requisição (para POST/PUT)	Esquema JSON
Respostas	Formatos de resposta e códigos de status esperados	`200 OK`, `404 Not Found`

Conceito-chave

Os endpoints do Apidog são orientados por especificação. Quando você define um endpoint, está criando tanto uma documentação quanto uma interface testável que gera requisições automaticamente.

Criando Endpoints

Pré-requisitos

Antes de criar endpoints, certifique-se de que você tenha:

Uma conta do Apidog e o aplicativo cliente do Apidog

Compreensão básica de métodos HTTP e conceitos de API

Um projeto criado no Apidog ao qual você deseja adicionar endpoints; consulte a página Visão geral para obter mais informações.

Início rápido: criação básica de endpoint

Navegue até o módulo APIs: clique na guia "APIs" na barra lateral

Crie um novo endpoint:

Clique no botão New HTTP Endpoint ou em + na árvore de diretórios e, em seguida, em New HTTP Endpoint

Selecione o módulo / pasta de destino

Essa ação coloca você no Modo Design-first (ou você pode fazer isso manualmente antes de criar uma requisição), no qual você define primeiro a especificação da API.

Métodos de criação de endpoint

Método	Quando usar	Etapas
Criação manual	Começando do zero	1. Clique com o botão direito na pasta → "New Endpoint" 2. Preencha o método e o caminho 3. Defina parâmetros e respostas
Importar do código	Código de API existente	1. Use o recurso "Import" 2. Carregue o arquivo OpenAPI/Swagger 3. Mapeie para módulos
A partir de uma requisição	Testando APIs existentes	1. Primeiro envie uma requisição 2. Clique em "Save" 3. Refine a especificação
Clonar existente	Endpoints semelhantes	1. Clique com o botão direito no endpoint → "Duplicate" 2. Modifique o caminho e os parâmetros

Especificando detalhes do endpoint

Informações básicas

Todo endpoint requer:

Nome: título descritivo (por exemplo, "Obter perfil do usuário")

Método: verbo HTTP

Caminho: caminho da URL com parâmetros

Descrição: o que o endpoint faz

Parâmetros

No workbench do Apidog, você pode definir parâmetros que personalizam o comportamento do endpoint da seguinte forma (os valores são usados apenas como exemplos):

Parâmetros de caminho

Usados no próprio caminho da URL:

GET /users/{userId}/posts/{postId}

Parâmetro	Tipo	Obrigatório	Descrição
`userId`	integer	Sim	Identificador exclusivo do usuário
`postId`	integer	Sim	Identificador da publicação

Parâmetros de consulta

Filtros opcionais e paginação:

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
`limit`	integer	Não	10	Número de resultados a retornar
`offset`	integer	Não	0	Número de resultados a ignorar
`status`	string	Não	active	Filtrar por status

Corpo da requisição (para POST/PUT)

Defina os dados de entrada esperados usando JSON Schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "User's full name"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "User's email address"
    }
  },
  "required": ["name", "email"]
}

Respostas

Defina todos os formatos de resposta possíveis:

Resposta de sucesso (200 OK)

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "createdAt": "2023-01-15T10:30:00Z"
}

Respostas de erro

Código de status	Descrição	Esquema
`400`	Bad Request	Detalhes do erro
`401`	Unauthorized	Erro de autenticação
`404`	Not Found	Recurso não encontrado
`500`	Internal Server Error	Detalhes do erro do servidor

A guia Design inclui opções estendidas de especificação de API.

Próxima etapa

Criar uma requisição

O que é um Endpoint?#

Criando Endpoints#

Pré-requisitos#

Início rápido: criação básica de endpoint#

Métodos de criação de endpoint#

Especificando detalhes do endpoint#

Informações básicas#

Parâmetros#

Parâmetros de caminho#

Parâmetros de consulta#

Corpo da requisição (para POST/PUT)#

Respostas#

Resposta de sucesso (200 OK)#

Respostas de erro#

O que é um Endpoint?

Criando Endpoints

Pré-requisitos

Início rápido: criação básica de endpoint

Métodos de criação de endpoint

Especificando detalhes do endpoint

Informações básicas

Parâmetros

Parâmetros de caminho

Parâmetros de consulta

Corpo da requisição (para POST/PUT)

Respostas

Resposta de sucesso (200 OK)

Respostas de erro