Git Product home page Git Product logo

captchagen's Introduction

API de generación y validación de CAPTCHAs

Esta API te permite generar y validar CAPTCHAs utilizando una imagen con una pregunta y una respuesta.

La API está construida con Node.js y Express, utilizando MongoDB como base de datos para almacenar los CAPTCHAs generados.

Instalación

Para instalar las dependencias de la aplicación, utiliza el siguiente comando:

yarn 

Luego, puedes iniciar la aplicación utilizando el siguiente comando:

yarn start

La aplicación estará disponible en http://localhost:3000.

Endpoints

Generar un nuevo CAPTCHA

Endpoint: GET /captcha

Este endpoint genera un nuevo CAPTCHA y devuelve su imagen y su UUID en formato JSON.

Ejemplo de respuesta exitosa:

{
"uuid": "0c6d0a6c-87e5-4c1e-8f8b-7f9d9f6dd7a6",
"message": "Mensaje de pregunta al usuario",
"image": "Imagen en Base64"
}

Validar un CAPTCHA existente

Endpoint: POST /captcha/:uuid

Este endpoint valida un CAPTCHA existente utilizando su UUID y la respuesta proporcionada por el usuario.

El cuerpo de la petición debe incluir la respuesta del usuario en formato JSON:

{
"answer": "respuesta_del_usuario"
}

Ejemplo de respuesta exitosa:

{
"message": "CAPTCHA validado correctamente",
"isOk": true
}

Documentación

La documentación completa de la API está disponible en /docs, donde se encuentra la interfaz de Swagger.

Pruebas

Para ejecutar las pruebas automatizadas, utiliza el siguiente comando:

yarn test

Este comando ejecutará todas las pruebas definidas en la carpeta __tests__.

Contribución

Si deseas contribuir a esta API, por favor crea un pull request con los cambios propuestos.

Licencia

Este proyecto está bajo la Licencia MIT. Puedes ver el archivo LICENSE para más detalles.

Contacto

Si tienes alguna duda o problema con la API, por favor contacta al desarrollador a través de su correo electrónico o redes sociales.

Autor

Desarrollado por @cvillanueva94.

captchagen's People

Contributors

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