Crear un Endpoint
¿Qué es un Endpoint?
| Componente | Descripción | Ejemplo |
|---|---|---|
| Método HTTP | La acción que se debe realizar | GET, POST, PUT, DELETE |
| Ruta | La ruta de URL relativa a la URL base | /users/{id} |
| Parámetros | Parámetros de ruta, consulta, encabezado o cuerpo | id (parámetro de ruta) |
| Cuerpo de la petición | Datos enviados con la petición (para POST/PUT) | Esquema JSON |
| Respuestas | Formatos de respuesta y códigos de estado esperados | 200 OK, 404 Not Found |
Concepto clave
Crear endpoints
Requisitos previos
Inicio rápido: creación básica de endpoints
1.
2.
Métodos de creación de endpoints
| Método | Cuándo usarlo | Pasos |
|---|---|---|
| Creación manual | Cuando empieza desde cero | 1. Haga clic con el botón derecho en la carpeta → "New Endpoint" 2. Complete el método y la ruta 3. Defina parámetros y respuestas |
| Importar desde código | Código de API existente | 1. Use la función "Import" 2. Cargue el archivo OpenAPI/Swagger 3. Asigne a módulos |
| Desde petición | Prueba de APIs existentes | 1. Primero envíe una petición 2. Haga clic en "Save" 3. Perfeccione la especificación |
| Clonar existente | Endpoints similares | 1. Haga clic con el botón derecho en el endpoint → "Duplicate" 2. Modifique la ruta y los parámetros |
Especificar los detalles del endpoint
Información básica
Parámetros
Parámetros de ruta
GET /users/{userId}/posts/{postId}| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
userId | integer | Sí | Identificador único de usuario |
postId | integer | Sí | Identificador de publicación |
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
limit | integer | No | 10 | Número de resultados que se deben devolver |
offset | integer | No | 0 | Número de resultados que se deben omitir |
status | string | No | active | Filtrar por estado |
Cuerpo de la petición (para POST/PUT)
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User's full name"
},
"email": {
"type": "string",
"format": "email",
"description": "User's email address"
}
},
"required": ["name", "email"]
}Respuestas
Respuesta correcta (200 OK)
{
"id": 123,
"name": "John Doe",
"email": "john@example.com",
"createdAt": "2023-01-15T10:30:00Z"
}Respuestas de error
| Código de estado | Descripción | Esquema |
|---|---|---|
400 | Bad Request | Detalles del error |
401 | Unauthorized | Error de autenticación |
404 | Not Found | Recurso no encontrado |
500 | Internal Server Error | Detalles del error del servidor |
Modified at 2026-06-09 08:52:14