Code Monkey home page Code Monkey logo

org-api's Introduction

Proyecto Backend con GraphQL

🚀 ¡Bienvenido a mi Proyecto Backend con GraphQL!

Este proyecto se realizó para demostrar mis habilidades y conocimientos en el desarrollo backend utilizando Node.js y GraphQL. Muestra cómo diseñar e implementar una API de GraphQL utilizando el esquema proporcionado para comunicar con mi otro proyecto creado con React, puedes ver mi proyecto aquí .

Características

  • 🎯 Utiliza el esquema de GraphQL para un diseño de API potente y eficiente.
  • 🌌 Configura MongoDB con índices para una gestión optimizada de datos.
  • ⏰ Implementa limpieza automática de documentos con eliminación automática de documentos que utilizan el campo "createdAt" después de 30 minutos.
  • 📄 Aplica validación de esquema utilizando MongoDB Compass.
  • 🚀 Integra Apollo para operaciones de GraphQL sin problemas.
  • 🪪 Uso de suscripciones con Apollo Server.

Esquema de GraphQL

type Query {
    random: Float!
    helpers: [Helper]
    teams: [Team]
}

type Helper {
    _id: ID!
    id: String
    name: String
    position: String
    photo: String
    team: Team
}

input HelperInput {
    id: String
    name: String
    position: String
    photo: String
    teamRef: String
}

type Team {
    _id: ID!
    id: String
    teamName: String
    colors: teamColors
}

type teamColors {
    primary: String
    background: String
}

type Subscription {
    newHelper: Helper
}

type Mutation {
    createHelper(input: HelperInput): Helper
}

Configuración de MongoDB

  • 📚 Se configura MongoDB con índices eficientes para un mejor rendimiento.
  • ⏳ La limpieza de documentos se automatiza con la eliminación de documentos que utilizan el campo "createdAt" después de 30 minutos.
  • 🛡️ Se implementa la validación de esquema utilizando MongoDB Compass para garantizar la consistencia de los datos.

Para ello crea una base de datos en MongoDB y crea 2 coleciones, una llamada teams y el otro helpers. Luego en helpers agregaremos 2 indices con los siguientes comandos:

db.helpers.createIndex({ id: 1 }, { unique: true });
db.helpers.createIndex({ id: 1 }, { unique: true });

y opcionalmente podemos agregar este validador de esquema en helpers:

{
  $jsonSchema: {
    required: [
      'id',
      'name',
      'position',
      'photo',
      'teamRef'
    ],
    properties: {
      id: {
        bsonType: 'string'
      },
      name: {
        bsonType: 'string'
      },
      position: {
        bsonType: 'string'
      },
      photo: {
        bsonType: 'string'
      },
      teamRef: {
        bsonType: 'objectId'
      },
      createdAt: {
        bsonType: 'date'
      }
    }
  }
}

Tan solo nos faltaría el esquema de teams, el cuál es el siguiente:

{
  $jsonSchema: {
    required: [
      'id',
      'teamName',
      'colors'
    ],
    properties: {
      id: {
        bsonType: 'string'
      },
      teamName: {
        bsonType: 'string'
      },
      colors: {
        bsonType: 'object'
      },
      'colors.primary': {
        bsonType: 'string'
      },
      'colors.background': {
        bsonType: 'string'
      }
    }
  }
}

Clona este repositorio.

Ahora que ya tenemos MongoDB configurado ya lo tenemos casi todo. Ahora realice lo siguiente:

  • Instale las dependencias con npm install.
  • Configura la conexión de MongoDB en la configuración del proyecto.
  • Ejecuta el proyecto con npm start.

¡Explora el esquema de GraphQL, experimenta con consultas y disfruta de esta API generada con Apollo!

Nota

Las variables de entorno para este proyecto son:

  • APOLLO_GRAPH_REF=
  • ALLOWED_ORIGINS=[]
  • MONGODB_URI=
  • NODE_ENV=
  • PORT=

org-api's People

Contributors

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