Documentación de la API REST


Rutas Disponibles

  • GET /api/cliente

    Retorna una lista de todos los clientes.

    GET /api/cliente HTTP/1.1
    Host: example.com
    
    [
      {
        "clienteId": 1,
        "nombre": "Juan Pérez",
        "correo": "juan.perez@example.com",
        "telefono": "5551234",
        "direccion": "Calle Falsa 123"
      },
      {
        "clienteId": 2,
        "nombre": "María Gómez",
        "correo": "maria.gomez@example.com",
        "telefono": "5555678",
        "direccion": "Avenida Siempre Viva 742"
      }
    ]
                            
  • GET /api/cliente/{id}

    Retorna la información de un cliente específico por ID.

    GET /api/cliente/1 HTTP/1.1
    Host: example.com
    
    {
      "clienteId": 1,
      "nombre": "Juan Pérez",
      "correo": "juan.perez@example.com",
      "telefono": "5551234",
      "direccion": "Calle Falsa 123"
    }
                            
  • POST /api/cliente

    Agrega un nuevo cliente.

    POST /api/cliente HTTP/1.1
    Host: example.com
    Content-Type: application/json
    
    {
        "nombre": "Juan Ayala",
        "correo": "juan.perez@example.com",
        "telefono": "12345678",
        "documento": "12345678",
        "direccion": "Calle Falsa 123"
    }
    
    
    HTTP/1.1 201 Created
    Location: /api/cliente/3
                            
  • PUT /api/cliente/{id}

    Actualiza un cliente existente por ID.

    PUT /api/cliente/1 HTTP/1.1
    Host: example.com
    Content-Type: application/json
    
    {
      "nombre": "Juan Pérez",
      "correo": "juan.perez@nuevoemail.com",
      "telefono": "5551234",
      "direccion": "Calle Actualizada 789"
    }
    
    HTTP/1.1 200 OK
                            
  • DELETE /api/cliente/{id}

    Elimina un cliente por ID.

    DELETE /api/cliente/1 HTTP/1.1
    Host: example.com
    
    HTTP/1.1 200 OK
                            

Ejemplo de Respuesta

{
  "clienteId": 1,
  "nombre": "Juan Pérez",
  "correo": "juan.perez@example.com",
  "telefono": "5551234",
  "direccion": "Calle Falsa 123"
}
            

Autenticación

Actualmente, la API no requiere autenticación basada en sesión.


Web hosting by Somee.com