Criar um Endpoint

Os endpoints são os blocos fundamentais das APIs no Apidog. Este guia apresenta como criar e especificar endpoints, ajudando-o a definir eficazmente as suas especificações de API.

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 executar	`GET`, `POST`, `PUT`, `DELETE`
Caminho	O caminho do URL relativo ao URL base	`/users/{id}`
Parâmetros	Parâmetros de caminho, consulta, cabeçalho ou corpo	`id` (parâmetro de caminho)
Corpo do Pedido	Dados enviados com o pedido (para POST/PUT)	Esquema JSON
Respostas	Formatos de resposta e códigos de estado esperados	`200 OK`, `404 Not Found`

Conceito-chave

Os endpoints do Apidog são orientados por especificações. Quando define um endpoint, está a criar simultaneamente documentação e uma interface testável que gera pedidos automaticamente.

Criar Endpoints

Pré-requisitos

Antes de criar endpoints, certifique-se de que tem:

Uma conta Apidog e a aplicação cliente Apidog

Conhecimento básico dos métodos HTTP e dos conceitos de API

Um projeto criado no Apidog onde pretende adicionar endpoints; consulte a página Visão geral para obter mais informações.

Início Rápido: Criação Básica de Endpoint

Navegar para o Módulo APIs: Clique no separador "APIs" na barra lateral

Criar 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

Esta ação coloca-o no Modo Design-first (ou pode fazê-lo manualmente antes de efetuar um pedido), onde define primeiro a especificação da API.

Métodos de Criação de Endpoint

Método	Quando Utilizar	Passos
Criação Manual	Começar do zero	1. Clique com o botão direito do rato na pasta → "New Endpoint" 2. Preencha o método e o caminho 3. Defina os parâmetros e as respostas
Importar a partir de Código	Código de API existente	1. Utilize a funcionalidade "Import" 2. Carregue o ficheiro OpenAPI/Swagger 3. Mapeie para módulos
A partir de Pedido	Testar APIs existentes	1. Envie primeiro um pedido 2. Clique em "Save" 3. Aperfeiçoe a especificação
Clonar Existente	Endpoints semelhantes	1. Clique com o botão direito do rato no endpoint → "Duplicate" 2. Modifique o caminho e os parâmetros

Especificar Detalhes do Endpoint

Informações Básicas

Cada endpoint requer:

Nome: Título descritivo (por exemplo, "Obter Perfil do Utilizador")

Método: Verbo HTTP

Caminho: Caminho do URL com parâmetros

Descrição: O que o endpoint faz

Parâmetros

Na área de trabalho do Apidog, pode definir parâmetros que personalizam o comportamento do endpoint da seguinte forma (os valores são utilizados apenas como exemplos):

Parâmetros de Caminho

Utilizados no próprio caminho do URL:

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

Parâmetro	Tipo	Obrigatório	Descrição
`userId`	integer	Sim	Identificador único do utilizador
`postId`	integer	Sim	Identificador da publicação

Parâmetros de Consulta

Filtros opcionais e paginação:

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

Corpo do Pedido (para POST/PUT)

Defina os dados de entrada esperados utilizando 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 Estado	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

O separador Design inclui opções alargadas de especificação de API.

Próximo Passo

Efetuar um Pedido

O que é um Endpoint?#

Criar Endpoints#

Pré-requisitos#

Início Rápido: Criação Básica de Endpoint#

Métodos de Criação de Endpoint#

Especificar Detalhes do Endpoint#

Informações Básicas#

Parâmetros#

Parâmetros de Caminho#

Parâmetros de Consulta#

Corpo do Pedido (para POST/PUT)#

Respostas#

Resposta de Sucesso (200 OK)#

Respostas de Erro#

O que é um Endpoint?

Criar Endpoints

Pré-requisitos

Início Rápido: Criação Básica de Endpoint

Métodos de Criação de Endpoint

Especificar Detalhes do Endpoint

Informações Básicas

Parâmetros

Parâmetros de Caminho

Parâmetros de Consulta

Corpo do Pedido (para POST/PUT)

Respostas

Resposta de Sucesso (200 OK)

Respostas de Erro