Giter Club home page Giter Club logo

equipos-futbol's Introduction

Equipos de fútbol

API para gestionar información de equipos de fútbol. Desarrollada con Spring Boot 3. Securizada con Spring Security.

Tabla de Contenidos

  1. Instalación
  2. Uso
  3. Endpoints de la API
  4. Ejemplos
  5. Contacto

Instalación

Instrucciones para clonar el repositorio, instalar las dependencias y ejecutar el proyecto.

git clone https://github.com/mateoymichis/equipos-futbol.git
cd equipos-futbol
./mvnw spring-boot:run

También se puede ejecutar el proyecto, luego de clonarlo, utilizando un IDE de Java.

Uso

La API se ejecutará en el puerto 8080 (se puede cambiar el puerto desde application.properties). Las peticiones a /equipos, se encuentran securizadas, por lo que primero se deberá registrar un usuario en la app y utilizar el token de la respuesta para que las peticiones sean exitosas. El proyecto está destinado a pruebas, por lo que se puede acceder a la documentación de Swagger (http://localhost:8080/swagger-ui/index.html) y a la base de datos en memoria H2 (http://localhost:8080/h2-console) sin autenticarse.

Endpoints de la API

Método Endpoint Descripción
PUT /auth/register Registrar usuario
PUT /auth/login Iniciar sesión
GET /equipos Obtener una lista con todos los equipos
GET /equipos/{id} Obtener equipo
POST /equipos Crear equipo
PUT /equipos Actualizar equipo
DELETE /equipos Eliminar equipo
GET /equipos?nombre={valor} Buscar equipo

Ejemplos

Endpoint

PUT /auth/register

Request

{
  "username": "test",
  "password": "12345",
  "firstname": "Juan",
  "lastname": "Perez",
  "email": "[email protected]"
}

Response (200 OK)

{
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0IiwiaWF0IjoxNzEzNjIyODYyLCJleHAiOjE3MTM2MjQzMDJ9.NjoCoezA1VF6MXULzDO_Ozjjco05-JK5OMYSTWVqyos"
}

Endpoint

PUT /auth/login

Request

{
  "username": "test",
  "password": "12345"
}

Response (200 OK)

{
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0IiwiaWF0IjoxNzEzNjIyODYyLCJleHAiOjE3MTM2MjQzMDJ9.NjoCoezA1VF6MXULzDO_Ozjjco05-JK5OMYSTWVqyos"
}

Response (401 Unauthorized)

Endpoint

GET /equipos

Response (200 OK)

[
  {
    "id": 2,
    "nombre": "FC Barcelona",
    "liga": "La Liga",
    "pais": "España"
  },
  {
    "id": 3,
    "nombre": "Manchester United",
    "liga": "Premier League",
    "pais": "Inglaterra"
  }
  // Otros equipos...
]

Endpoint

GET /equipos/1

Response (200 OK)

{
  "id": 2,
  "nombre": "FC Barcelona",
  "liga": "La Liga",
  "pais": "España"
}

Response (404 Not Found)

{
  "mensaje": "Equipo no encontrado",
  "codigo": 404
}

Endpoint

POST /equipos

Request

{
  "nombre": "Boca Juniors",
  "liga": "Primera A",
  "pais": "Argentina"
}

Response (201 Created)

{
  "id": 25,
  "nombre": "Boca Juniors",
  "liga": "Primera A",
  "pais": "Argentina"
}

Response (400 Bad Request)

{
  "mensaje": "La solicitud es invalida",
  "codigo": 400
}

Endpoint

PUT /equipos/1

Request

{
  "nombre": "Boca Juniors",
  "liga": "Primera A",
  "pais": "Argentina"
}

Response (200 OK)

{
  "id": 1,
  "nombre": "Boca Juniors",
  "liga": "Primera A",
  "pais": "Argentina"
}

Response (404 Not Found)

{
  "mensaje": "Equipo no encontrado",
  "codigo": 404
}

Endpoint

DELETE /equipos/1

Response (204 No Content)

Response (404 Not Found)

{
  "mensaje": "Equipo no encontrado",
  "codigo": 404
}

Endpoint

GET /equipos?nombre={valor}

Response (200 OK)

[
  {
    "id": 2,
    "nombre": "FC Barcelona",
    "liga": "La Liga",
    "pais": "España"
  },
  {
    "id": 3,
    "nombre": "Manchester United",
    "liga": "Premier League",
    "pais": "Inglaterra"
  }
  // Otros equipos...
]

Contacto

Mateo Fernandez

Email: [email protected]

equipos-futbol's People

Contributors

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