https://github.com/joanbr4/rest-api-hexagonal

app ToDo List sencilla con express en Ts
https://github.com/joanbr4/rest-api-hexagonal

class express hexagonal-architecture node

Last synced: about 2 months ago
JSON representation

app ToDo List sencilla con express en Ts

• Host: GitHub
• URL: https://github.com/joanbr4/rest-api-hexagonal
• Owner: joanbr4
• Created: 2024-01-29T12:38:27.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-29T22:46:55.000Z (over 1 year ago)
• Last Synced: 2025-02-07T09:20:23.357Z (3 months ago)
• Topics: class, express, hexagonal-architecture, node
• Language: TypeScript
• Homepage:
• Size: 150 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Rest Api Hexagonal

Comando principales para ejecutar:

Inicia el server con la app ToDo + arquitectura hexagonal

```sh

npm run app

```

`npm run eslint` Ejecuta el eslint

`npm test` Ejecuta el test

## Que es una API REST?

Una API REST es una interfaz de comunicacion del lado del servidor que se comunica con el navegador (Cliente) mediante los endpoint y devuelve respuestas, archivos, estados, etc.

Utiliza los metodos HTTP:

- GET

- POST

- DELETE

- PUT

## Que es la arquitctura hexagonal?

Es una arquitectura de sofware que trata de distribuir un proyecto en 3 niveles de compromiso:

![foto hexagonal](https://miro.medium.com/v2/resize:fit:4800/format:webp/1*LpmkeWbePqKAgVm07ORlxg.png)

Los niveles tienen una intencionanilidad de poder trabajar de manera abstracta y classificar el proyecto según esto, para así, poder llevarlo a un nivel de modularidad que facilite cualquier actualización/cambio de consulta de datos, interfaz, endpoints, etc.

Nuestro API Rest será sobre una aplicacion `ToDo List` en la que implementaremos el CRUD con clases y utilizando express como framework.

Para probar sus métodos, utiliza POSTMAN o la extensiÓn Thunder Client de VSC, permiten hacer peticiones a una API, nuestra direccion saldrá imprimida nada más inicar la API ==> 'http://localhost:PORT/api'

El manejo será de la siguiente manera:

`/marcarTasca` con unos valores en json `{id: 1}` ==> te marcará como completada la tasca.

`/mostrarTasca` No tiene parámetros ==> te mostrara todas las tascas.

`/anyadirTasca` con unos valores en json `{task: 'data_a_añadir'}` ==> te añadirá la tasca deseada.

`/borrarTasca` con unos valores en json `{id: 1}` ==> te borrará la tasca con ese id.