apihub
v1.3.0
Estamos tratando de construir un centro API de una sola fuente que se pueda usar para aprender el manejo de API en cualquier lenguaje de programación. Los usuarios pueden construir su cartera de front -end en aplicaciones web y móviles utilizando este Hub API.
El proyecto Freeapi es una iniciativa innovadora y dirigida por la comunidad destinada a proporcionar a los desarrolladores API gratuitos y accesibles para sus proyectos.
El proyecto se centra en ofrecer una amplia gama de API que atienden a varios dominios y funcionalidades, lo que permite a los desarrolladores integrar sin problemas estas API en sus aplicaciones.
Los aspectos más destacados del proyecto Freeapi incluyen:
Accesibilidad: El Proyecto Freeapi se compromete a eliminar las barreras al proporcionar acceso gratuito a su colección de API. Los desarrolladores pueden aprovechar estas API sin limitaciones de costos, lo que les permite experimentar, aprender y crear aplicaciones innovadoras.
Diversa colección API: el proyecto ofrece una colección diversa e integral de API que abarcan diferentes industrias, dominios y funcionalidades. Ya sea que necesite integraciones de redes sociales, pasarelas de pago, algoritmos de aprendizaje automático o conectividad del dispositivo IoT, el proyecto Freeapi lo tiene cubierto.
Integración simplificada: el proyecto Freeapi comprende los desafíos que enfrentan los desarrolladores al integrar API en sus aplicaciones. Para abordar esto, el proyecto proporciona documentación clara, muestras de código y SDK, simplificando el proceso de integración y reduciendo el tiempo y el esfuerzo de desarrollo.
Desarrollo impulsado por la comunidad: el proyecto fomenta una comunidad vibrante y colaborativa de desarrolladores. Se alienta a los contribuyentes a compartir sus conocimientos, participar en discusiones y colaborar en proyectos relacionados con API. Este esfuerzo colectivo garantiza la mejora y confiabilidad continuas de las API ofrecidas por el Proyecto Freeapi.
Desarrollo de aprendizaje y habilidades: el proyecto Freeapi tiene como objetivo empoderar a los desarrolladores al proporcionar una plataforma para el aprendizaje y el desarrollo de habilidades. A través del acceso a diversas API y recursos educativos, los desarrolladores pueden mejorar su comprensión de la integración de API, ampliar sus conocimientos y mostrar su experiencia a través de la construcción de proyectos completos.
En general, el proyecto Freeapi es un recurso valioso para los desarrolladores que buscan API accesibles y diversas.
Al fomentar una comunidad de apoyo, el proyecto permite a los desarrolladores a aprender, crear e innovar, en última instancia, contribuyendo al crecimiento y el avance del panorama de integración de API.
Introducción de nuestro innovador proyecto API de código abierto, una plataforma dinámica diseñada para revolucionar la forma en que los desarrolladores interactúan con las API.
Con un énfasis en la apertura, la accesibilidad y el aprendizaje, nuestro API Hub permite a los desarrolladores de todos los niveles explorar, experimentar y aumentar sus habilidades en la integración de API.
Reflejos:
Open Fore: Nuestro centro API se basa en los principios de código abierto, asegurando la transparencia, la colaboración y el desarrollo impulsado por la comunidad. Esto significa que el código fuente está disponible gratuitamente, lo que permite a los desarrolladores personalizar, extender y contribuir al proyecto.
Free to Using: creemos firmemente en eliminar las barreras de entrada, por lo que nuestro Hub API es completamente gratuito de usar. Ya sea que sea un desarrollador experimentado o simplemente comience su viaje de codificación, puede aprovechar nuestra plataforma sin limitaciones de costos.
Local o implementación : la flexibilidad es el núcleo de nuestro Hub API. Tiene la opción de usarlo localmente, ejecutar en su propia máquina o implementarla en un servidor, haciéndolo accesible para otros. Esta versatilidad garantiza que pueda adaptar la plataforma a su entorno de desarrollo específico.
Recurso de aprendizaje : Nuestro centro API está diseñado como un recurso de aprendizaje integral, que ofrece una gran cantidad de materiales educativos, tutoriales y documentación. Ya sea que sea un principiante o busque expandir su conocimiento de API, nuestra plataforma proporciona los recursos que necesita para aprender y mejorar.
Puntos finales personalizados para principiantes : para los desarrolladores en el nivel principiante, nuestro API Hub ofrece puntos finales personalizados que proporcionan una experiencia práctica en el manejo de respuestas de API. Estas API para principiantes le permiten practicar y familiarizarse con los conceptos básicos de trabajar con API.
API avanzadas para la construcción de cartera : además de los puntos finales a nivel principiante, nuestro Hub API también proporciona API avanzadas para desafiar y estirar sus habilidades. Estas API le permiten abordar escenarios de integración más complejos, lo que le ayuda a construir una cartera robusta de proyectos para mostrar su experiencia.
Al combinar los principios de código abierto, la accesibilidad y un enfoque en el aprendizaje, nuestro proyecto API Hub allana el camino para que los desarrolladores prosperen en el mundo de la integración de API. Únase a nuestra vibrante comunidad y emprenda un emocionante viaje de descubrimiento, crecimiento e innovación.
Nuestro proyecto de código abierto se aloja actualmente en un servidor remoto, donde nos vemos obligados a restablecer todo el servidor, incluido el sistema de archivos y la base de datos MongoDB , cada 2 horas para evitar incurrir en costos adicionales.
Este proceso da como resultado la eliminación de todos los archivos de imagen/estáticos y un reinicio de toda la base de datos en el servidor.
Pérdida de datos: Cualquier cambio realizado durante el intervalo de 2 horas (en el servidor remoto), incluidas las imágenes cargadas y los datos del usuario, se perderán y no se pueden obtener.
Interrupción del servicio: el restablecimiento del servidor podría interrumpir sus procesos de desarrollo y prueba durante una cierta duración mientras el servidor se reinicia (durante 1-2 minutos).
Uso local de la API: para fines de desarrollo y prueba, recomendamos utilizar la API localmente en su máquina clonando el proyecto .
Esto asegura que su trabajo no se vea afectado por el reinicio del servidor y le permite mantener un entorno de desarrollo estable en su máquina local.
Autohospedado en el ferrocarril (recomendado para proyectos personales) : para autoestima la aplicación Freeapi.App, puede aprovechar una plantilla preconstruida que está fácilmente disponible. Haga clic aquí para obtener documentos detallados
Para ejecutar el proyecto Freeapi, siga estos pasos:
.env en la carpeta raíz y copie Pegue el contenido de .env.sample y agregue las credenciales necesarias.docker-compose up --build --attach backend
# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodbPara ejecutar el proyecto Freeapi localmente, siga estos pasos:
.env en la carpeta raíz y copie Pegue el contenido de .env.sample y agregue las credenciales necesarias.yarn installyarn startPara anotar la aplicación Freeapi.App, puede aprovechar una plantilla preconstruida que está fácilmente disponible.
Haga clic en el botón de arriba para visitar el ferrocarril. App.
Haga clic en el botón Implementar ahora .
(Opcional) Inicie sesión con GitHub para implementar.
Complete los detalles del repositorio:
Para las variables de entorno, hemos proporcionado algunos valores predeterminados en el ENV para reducir la carga, pero algunos parámetros son obligatorios:
PORT : No cambie el valor, que se establezca en 8080 para ver los documentos de Swagger después de la implementación.MONGODB_URI : proporcione la URL de la base de datos MongoDB Atlas. Se precede un ejemplo para usted, edítelo/actualizado para continuar.NODE_ENV : predeterminado Establecer en 'Desarrollo' para ver los registros. Puede optar por cambiarlo a 'producción' (asegúrese de agregar exactamente la misma palabra) para ocultarlos.EXPRESS_SESSION_SECRET : se recomienda cambiar el valor predeterminado a su propio valor secreto.ACCESS_TOKEN_SECRET : se recomienda cambiar el valor predeterminado a su propio valor secreto.ACCESS_TOKEN_EXPIRY : Establecer en 1 día como predeterminado.REFRESH_TOKEN_SECRET : se recomienda cambiar el valor predeterminado a su propio valor secreto.REFRESH_TOKEN_EXPIRY : Establecer en 10 días como predeterminado.FREEAPI_HOST_URL : establecerlo como URL de ferrocarril generado.Una vez que complete los parámetros de entorno requeridos, si elige agregar otros como PayPal, Google y Razorpay, proceda a mencionar sus credenciales en el formulario.
Haga clic en el botón Implementar para activar la primera compilación.
Nota: Una vez que se implementa la aplicación, espere de 3 a 5 minutos para que los documentos de Swagger estén disponibles.
Para garantizar la confiabilidad y estabilidad para nuestros usuarios finales, utilizamos el dramaturgo, un poderoso marco de pruebas para automatizar las pruebas en todos los puntos finales.
Asegúrese de agregar MONGO_MEMORY_SERVER_PORT=10000 (puerto MongoDB para pruebas E2E) en su archivo .env .
yarn start:test-serveryarn test:playwrightEsto generará un informe de dramaturgo. Para ver este informe, ejecute el siguiente comando
yarn playwright show-reportAsegúrese de que se pasen todos los casos de prueba cuando realice algún cambio.
¡Agradecemos su interés en contribuir a nuestro proyecto de código abierto!
Para contribuir a Freeapi, siga estos pasos:
git checkout -b feat/your-feature-name o git checkout -b fix/your-bug-fix-name y realice sus cambios.git commit -am 'add your commit message'git push origin feat/your-feature-name .Aquí hay una guía sobre cómo puede contribuir de manera efectiva a nuestro Hub API:
Solicitud de actualizaciones de ReadMe: Abstenerse de enviar solicitudes de extracción únicamente para actualizar el archivo ReadMe del proyecto. Si bien apreciamos la importancia de la documentación clara y concisa, preferimos centrarnos en las contribuciones de código sustanciales y las mejoras de características.
Actualizaciones de gramática: nuestro equipo valora la comunicación efectiva, pero no somos pegatinas gramaticales. No necesita enviar solicitudes de extracción únicamente para soluciones de gramática o mejoras de lenguaje menores. En su lugar, concéntrese en las funcionalidades y características centrales del proyecto.
Evite actualizar las API públicas existentes: para mantener la estabilidad y la consistencia, desalentamos las actualizaciones directas a las API públicas existentes dentro del HUB API. Estas API han sido probadas y aprobadas a fondo. Sin embargo, si se encuentra con algún error o problema, le recomendamos que abra un problema en el rastreador de problemas de nuestro proyecto para notificarnos.
Construya nuevas API de proyectos: lo alentamos a explorar su creatividad y contribuir mediante la creación de API completas de proyectos. Estas API deben proporcionar soluciones integrales que puedan ayudar a los desarrolladores a construir proyectos complejos para mostrar sus habilidades y habilidades. Sus contribuciones en esta área beneficiarán enormemente a la comunidad.
Reduzca una propuesta y debatir sobre Discord: antes de sumergirse en su proyecto, recomendamos redactar una propuesta. Esto puede incluir un mapa mental o un esquema de la API que tiene la intención de construir y sus beneficios potenciales. Únase a nuestra comunidad de Discord, donde pueda compartir su propuesta, discutir ideas y recopilar comentarios de otros colaboradores. Participar en estas discusiones mejorará su cartera de back -end y ayudará a dar forma a la dirección futura del proyecto.
Agradecemos su entusiasmo y esperamos sus valiosas contribuciones a nuestro proyecto API Hub de código abierto.
Juntos, podemos fomentar un entorno colaborativo y tener un impacto significativo en el panorama de integración de API.
Haga clic aquí para obtener una guía de contribución detallada.
¡Gracias por su interés en contribuir al proyecto Freeapi creando aplicaciones frontend que consuman Freeapis! Sus esfuerzos juegan un papel crucial para mejorar la experiencia del usuario y ampliar el alcance de nuestras API. Siga esta guía para garantizar un proceso de contribución suave y colaborativa.
¡Haga clic aquí para obtener una guía de contribución detallada para los desarrolladores de frontend!
Gracias por su interés en contribuir al proyecto Freeapi para aumentar la cobertura de código de nuestro servicio API que nos ayuda a enviar puntos finales robustos que se prueban el campo de batalla. Siga esta guía para garantizar un proceso de contribución suave y colaborativa.
Haga clic aquí para obtener una guía de contribución detallada para aumentar la cobertura de código.
Swagger Docs: https://api.freeapi.app
Nota: Los documentos de Swagger se generan automáticamente desde el archivo swagger.yaml . Mientras ejecuta el proyecto localmente, asegúrese de cambiar la URL a http://localhost:<port_from_.env>/api/v1 en el campo Swagger Docs servers/url .
