Git Product home page Git Product logo

pfcti-customer-netcore's Introduction

pfcti-customers-core

Prueba Técnica para PFCTI (.Net Core)

Stack Tecnológico

  • .NET 8.0 SDK
  • PostgreSQL 16.3
  • Postman 11.6.1
  • Docker 27.1.1

IDE Utilizado

  • Visual Studio Code 1.92

Visual Studio Code Extensions

Pasos para ejecutar el proyecto

  1. Desde la raíz del proyecto, ejecutar el siguiente comando en consola:

    docker compose up

  2. Al finalizar levantará el postgres con la estructura necesaria en el puerto 5434 y el API de Customers en el puerto 5244

Pasos para realizar pruebas desde Postman

  1. Abrir postman
  2. Importar el archivo pfcti-customers-netcore.postman_collection.json desde postman
  3. Ejecutar los endpoints desde postman

Pasos para realizar pruebas desde Rest Client

  1. Abrir VS Code
  2. Tener instalado la extensión Rest Client
  3. Ir al archivo test-customers.http y ejecutar los endpoints
  4. Para ejeccutar cada endpoint, debajo del comentario con los numerales (####), se debe de presionar la opción Send Request

Ejecutar Pruebas Unitarias

  1. Desde el directorio raíz, ir a directorio de Tests

    cd Tests

  2. Ejecutar el siguiente comando:

    dotnet test

Ejecutar la Consola

  1. Tener desplegado en docker el proyecto. Ver Pasos para desplegar el proyecto en docker

  2. Desde el directorio raíz, ir a la carpeta app

    cd App

  3. Ejecutar el siguiente comando:

    dotnet run --property WarningLevel=0

API Endpoints

POST /api/customers

Agrega un nuevo cliente

Request Ejemplo

{
    "id": "123456",
    "firstName": "Paul",
    "lastName": "McCartney",
    "phone": "+50671717171",
    "birthDate": "1942-06-18"
}

Respuesta Ejemplo

{
    "id": "123456",
    "firstName": "Paul",
    "lastName": "McCartney",
    "phone": "+50671717171",
    "birthDate": "1942-06-18"
}

o si genera algún error:

{
    "errors": [
        "El id del cliente que desea agregar ya existe"
    ]
}

PUT /api/customers/{id}

Edita un cliente

Parámetros

Nombre Descripción
id Id del cliente

Request Ejemplo

{
    "firstName": "Paul",
    "lastName": "McCartney",
    "phone": "+50671717171",
    "birthDate": "1942-06-18"
}

Respuesta Ejemplo

{
    "id": "123456",
    "firstName": "Paul",
    "lastName": "McCartney",
    "phone": "+50671717171",
    "birthDate": "1942-06-18"
}

o si genera algún error:

{
    "errors": [
        "El cliente que desea consultar no existe"
    ]
}

DELETE /api/customers/{id}

Elimina un cliente

Parámetros

Nombre Descripción
id Id del cliente

Respuesta Ejemplo

123456

GET /api/customers/{id}

Consulta un cliente por el id

Parámetros

Nombre Descripción
id Id del cliente

Respuesta Ejemplo

{
    "id": "123456",
    "firstName": "Paul",
    "lastName": "McCartney",
    "phone": "+50671717171",
    "birthDate": "1942-06-18"
}

o si genera algún error:

{
    "errors": [
        "El cliente que desea consultar no existe"
    ]
}

GET /api/customers?orderBy={orderBy}

Lista los clientes de acuerdo al parámetro indicado

Parámetros

Nombre Descripción
orderBy Campo por el cual se va a ordenar la lista. Los campos disponibles son: birthDate, id, name

Respuesta Ejemplo

[
    {
        "id": "133333333",
        "firstName": "Alejandro Esteban",
        "lastName": "Navarro Sanchez",
        "phone": "+50683838383",
        "birthDate": "1989-04-18"
    },
    {
        "id": "122345632",
        "firstName": "Paul",
        "lastName": "McCartney",
        "phone": "+50671717171",
        "birthDate": "1942-06-19"
    },
    {
        "id": "1234562",
        "firstName": "Paul",
        "lastName": "McCartney",
        "phone": "+50671717171",
        "birthDate": "1942-06-18"
    },
    {
        "id": "123456",
        "firstName": "Paul",
        "lastName": "McCartney",
        "phone": "+50671717171",
        "birthDate": "1942-06-18"
    }
]

pfcti-customer-netcore's People

Contributors

estenavarro1989 avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.