Giter VIP home page Giter VIP logo

api-forohub's Introduction

Alura ONE Foro Hub Challenge

Acerca del proyecto

Alura One Foro Hub Challenge es un proyecto realizado completamente por "Alejandro Orozco" con la intervención y ayuda del programa de cursos de AluraONE. Consiste en el desarrollo de una APIRest desde cero, utilizando varias metodologías y paradigmas de programación acordes con las solicitadas requeridas en el campo laboral. El proyeto es totalmente producido en el IDE Intelli J, utilizando herramientas como Insomnia (test de requests) y MySQLWorkBench (DBMS). La API acepta request del tipo:

  • GET
  • POST
  • PUT
  • DELETE

Se utlizaron las dependencias:

  • Spring Data JPA
  • MySQL Driver
  • OpenAPI Doc
  • JWT Auth0
  • Spring Security
  • Validation
  • Flyway Migration
  • Spring Boot DevTools
  • Lombok

La API cuenta con seguridad para todas las request, excepto el login de usuario, por tanto, primero se debera iniciar sesion de usuario, a lo cual, se devolverá como respuesta un BearerToken, esté mismo será utilizado en todas las request, el Token cuenta con un tiempo de expiración de 2hrs.

Instrucciones de Uso

La API únicamente sirve dentro de consola al tratarse de una aplicación de Back-End, por tanto se necesita de programas terceros para poder hacer las request dentro de la API, se recomienda POSTMAN o Insomnia. Además, la API utiliza una base de datos MySQL debido al Driver instanciado en las propiedades del programa, si desea utilizar otro tipo de base de datos, es necesario cambiar el driver. Independientemente del DBMS que se esté utilizando, el programa no realizar la creación de la base de datos por sí mismo, por lo cual sera necesario crear la base de datos con el nombre utilizado en las propiedades. EL nombre de la propiedad de la base de datos esta resguardado dentro de variables de entorno las cuales deberán ser agregadas y configuradas dentro de la Base de Datos para que se pueda acceder a la misma.

Los Usuario deben ser agregados dentro del DBMS debido a que no existe solicitud para ingresar usuarios a la base de datos. Todos los usuarios gozan de los mismos permisos.


Para saber más acerca del uso de la API está cuenta con docuementación brindada por OpenAPI con la cual podremos ver las solicitudes del cuerpo del cada request y su funcionamiento.

Agradecimientos

Agradezco de todo corazón a ALuraONE por su compromiso, trabajo y esfuerzo puesto en sus cursos, así como la oportunidad de seguir creciendo como programador y en el desarrollo de mi carreara profesional. Atte: Alejandro Orozco(ceguian)

api-forohub's People

Contributors

ceguian avatar

Watchers

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