Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

MenuMarino/StarWarsAPI

Open more actions menu

Repository files navigation

Star Wars API

Requisitos

  • Node.js v21.0.5
  • Serverless instalado
  • Credenciales de AWS configuradas para despliegue

Instalación y Despliegue

Sigue los siguientes pasos para ejecutar el proyecto:

  1. Instalar las dependencias:

    npm install
  2. Despliega el proyecto utilizando Serverless:

    serverless deploy

Documentación

La documentación del API se encuentra disponible en Swagger

Rutas de la API

1. /create-resource (POST)

Esta ruta permite crear un nuevo recurso en DynamoDB.

  • Body:

    {
      "resource": "people",
      "id": 1
    }
  • Respuesta exitosa (201 Created):

    {
      "message": "Resource saved successfully"
    }

2. /get-resource (GET)

Esta ruta obtiene uno o varios recursos almacenados en la base de datos.

  • Query Params:

    • resource: Tipo de recurso a buscar (e.g., people, films).
    • id (opcional): El ID del recurso que se desea obtener. Si no se proporciona, se devuelven todos los recursos en la base de datos.
  • Respuesta sin ID (200 OK):

    {
      "message": "Resources fetched successfully",
      "data": [
        {
          "id": 1,
          "resourceType": "people",
          "data": {
            "nombre": "Luke Skywalker",
            "año_de_nacimiento": "19BBY",
            "género": "male",
            "naves_estelares": [
              "https://swapi.py4e.com/api/starships/12/",
              "https://swapi.py4e.com/api/starships/22/"
            ]
            // etc...
          }
        },
        {
          "id": 2,
          "resourceType": "people",
          "data": {
            "nombre": "C-3PO",
            "año_de_nacimiento": "112BBY",
            "género": "n/a",
            "naves_estelares": []
            // etc...
          }
        }
      ]
    }
  • Respuesta con ID (200 OK):

    {
      "message": "Resources fetched successfully",
      "data": {
        "id": 1,
        "resourceType": "people",
        "data": {
          "nombre": "Luke Skywalker",
          "año_de_nacimiento": "19BBY",
          "género": "male",
          "naves_estelares": [
            "https://swapi.py4e.com/api/starships/12/",
            "https://swapi.py4e.com/api/starships/22/"
          ]
          // etc...
        }
      }
    }

Testing

Para ejecutar las pruebas unitarias se ejecuta el siguiente comando

npx jest

Las pruebas se encuentras definidas en ./__tests__

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Morty Proxy This is a proxified and sanitized view of the page, visit original site.