GithubHelp home page GithubHelp logo

instashareapinest's Introduction

Demo Api Rest con Nestjs

Description

Desarrollado para fines demostrativos y prácticos con framework Nest version 8.0.0, donde se plantean los siguientes requisitos:

  • Realizar Api Rest que posibilite registro de usuario, control de accceso, gestión de post y cargas de imágenes para ser publicadas dentro del mismo servidor.

  • Utilizar sequelize v6 como ORM.

  • Utilizar Swagger para describir las operaciones que estarán disponibles en el API.

  • Utiliza JWT con Passport como estrategia de autenticación

  • Se deben implementar test automáticos.

Desarrollo

  • Se crean modelos con sequelize fuertemente typados, con validaciones y documentación swagger: user, profile, post

  • Se implementa campo virtual (avatarUrl) en modelo user

  • Se utiliza el middleware Multer y se implementan decorators ApiFiles, ApiFileFields y el PipeTransform ParseFile para facilitar el manejo de carga de ficheros.

  • Se permite acceso estático a las imágenes cargadas en el servidor con el módulo serve-static.

  • Se crean servicios donde se realizan todas las operaciones con modelos y base de datos auth, users, profile, posts.

  • Se utilizan transaction cuando se realizan más de un operaciones de CRUD en una misma funcionalidad para posibilitar realizar commit/rollback.

  • Se implementa módulo de autenticación y se restinguen los Access Point requeridos con:

  @UseGuards(AuthGuard('jwt'))
  • Se documentan los controller ( auth, profiles, files, post ) con decoradores de la libreria nestjs/swagger donde se describen todas las operaciones disponibles en el Api, con nombre de Access Point, método (Get, Post, Post, Delete), parámetros y respuestas con tipos de datos y ejemplos.

  • Se implementan test e2e para las operaciones: registro, login, crear post, carga de fichero.

Implementación de la solución

  1. Clonar repositorio: https://github.com/yurisnel/InstaShareApiNest
  2. Descargar dependencias:
$ npm install
  1. Para ejecutar servidor:
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
  1. Para ejecutar test:
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
  1. Abrir api doc en navegador en: http://localhost:3000/api/

PD: Esta Api Rest es utilizada por el proyecto https://github.com/yurisnel/InstaShareAngular

instashareapinest's People

Contributors

yurisnel 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.