apihub
v1.3.0
Nous essayons de construire un hub API source unique qui peut être utilisé pour apprendre la manipulation de l'API dans n'importe quel langage de programmation. Les utilisateurs peuvent créer leur portefeuille frontal dans les applications Web et mobiles à l'aide de ce centre API.
Le projet Freapi est une initiative innovante et axée sur la communauté destinée à fournir aux développeurs des API gratuites et accessibles pour leurs projets.
Le projet se concentre sur la fourniture d'un large éventail d'API qui s'adresse à divers domaines et fonctionnalités, permettant aux développeurs d'intégrer de manière transparente ces API dans leurs applications.
Les principaux points forts du projet Freapi comprennent:
Accessibilité: Le projet Freapi s'engage à éliminer les obstacles en fournissant un accès gratuit à sa collection d'API. Les développeurs peuvent tirer parti de ces API sans aucune limitation de coût, ce qui leur permet d'expérimenter, d'apprendre et de créer des applications innovantes.
Diverse collection API: Le projet propose une collection diversifiée et complète d'API qui s'étend sur différentes industries, domaines et fonctionnalités. Que vous ayez besoin d'intégrations des médias sociaux, de passerelles de paiement, d'algorithmes d'apprentissage automatique ou de connectivité des périphériques IoT, le projet Freapi vous a couvert.
Intégration simplifiée: le projet Freapi comprend les défis auxquels les développeurs sont confrontés lors de l'intégration d'API dans leurs applications. Pour y remédier, le projet fournit une documentation claire, des échantillons de code et des SDK, simplifiant le processus d'intégration et réduisant le temps et les efforts de développement.
Développement communautaire: le projet favorise une communauté dynamique et collaborative de développeurs. Les contributeurs sont encouragés à partager leurs connaissances, à s'engager dans des discussions et à collaborer sur des projets liés à l'API. Cet effort collectif garantit l'amélioration et la fiabilité continue des API offertes par le projet Freapi.
Apprentissage et développement des compétences: Le projet Freapi vise à autonomiser les développeurs en fournissant une plate-forme pour l'apprentissage et le développement des compétences. Grâce à l'accès à diverses API et ressources éducatives, les développeurs peuvent améliorer leur compréhension de l'intégration des API, élargir leurs connaissances et présenter leur expertise en créant des projets complets.
Dans l'ensemble, le projet Freapi est une ressource précieuse pour les développeurs à la recherche d'API accessibles et diverses.
En favorisant une communauté de soutien, le projet permet aux développeurs d'apprendre, de créer et d'innover, contribuant finalement à la croissance et à l'avancement du paysage de l'intégration de l'API.
Présentation de notre projet révolutionnaire API Hub Project, une plate-forme dynamique conçue pour révolutionner la façon dont les développeurs interagissent avec les API.
En mettant l'accent sur l'ouverture, l'accessibilité et l'apprentissage, notre centre API permet aux développeurs de tous niveaux d'explorer, d'expérimenter et de développer leurs compétences en intégration des API.
Points forts:
Open source: Notre hub API est construit sur les principes de l'open source, assurant la transparence, la collaboration et le développement axé sur la communauté. Cela signifie que le code source est disponible librement, permettant aux développeurs de personnaliser, d'étendre et de contribuer au projet.
GRATUIT à utiliser: nous croyons fermement à la suppression des obstacles à l'entrée, c'est pourquoi notre hub API est entièrement libre à utiliser. Que vous soyez un développeur chevronné ou que vous commenciez simplement votre parcours de codage, vous pouvez tirer parti de notre plate-forme sans aucune limitation de coût.
Local ou déploiement : la flexibilité est au cœur de notre centre API. Vous avez la possibilité de l'utiliser localement, d'exécuter sur votre propre machine ou de le déployer sur un serveur, ce qui le rend accessible à d'autres. Cette polyvalence garantit que vous pouvez adapter la plate-forme à votre environnement de développement spécifique.
Ressource d'apprentissage : Notre hub API est conçu comme une ressource d'apprentissage complète, offrant une multitude de matériels éducatifs, de tutoriels et de documentation. Que vous soyez un débutant ou que vous cherchiez à élargir vos connaissances API, notre plateforme fournit les ressources dont vous avez besoin pour apprendre et améliorer.
Points de terminaison personnalisés pour les débutants : pour les développeurs au niveau débutant, notre hub API propose des points de terminaison personnalisés qui offrent une expérience pratique dans la gestion des réponses de l'API. Ces API adaptées aux débutants vous permettent de pratiquer et de vous familiariser avec les bases du travail avec les API.
API avancées pour la construction de portefeuille : En plus des points de terminaison au niveau débutant, notre centre API fournit également des API avancées pour défier et étirer vos compétences. Ces API vous permettent de s'attaquer aux scénarios d'intégration plus complexes, vous aidant à créer un portefeuille robuste de projets pour présenter votre expertise.
En combinant les principes open source, l'accessibilité et l'accent mis sur l'apprentissage, notre projet API Hub ouvre la voie aux développeurs pour prospérer dans le monde de l'intégration des API. Rejoignez notre communauté dynamique et lancez un voyage passionnant de découverte, de croissance et d'innovation.
Notre projet open-source est actuellement hébergé sur un serveur distant, où nous sommes obligés de réinitialiser l'ensemble du serveur, y compris le système de fichiers et la base de données MongoDB , toutes les 2 heures pour éviter les coûts supplémentaires.
Ce processus entraîne la suppression de tous les fichiers image / statique et une réinitialisation de la base de données entière sur le serveur.
Perte de données: toutes les modifications apportées au cours de l'intervalle de 2 heures (sur le serveur distant), y compris les images téléchargées et les données utilisateur, seront perdues et irréalisables.
Interruption de service: la réinitialisation du serveur peut perturber vos processus de développement et de test pour une certaine durée pendant que le serveur redémarre (pendant 1 à 2 minutes).
Utilisation locale de l'API: À des fins de développement et de test, nous recommandons fortement d'utiliser l'API localement sur votre machine en clonant le projet .
Cela garantit que votre travail n'est pas affecté par les réinitialisations du serveur et vous permet de maintenir un environnement de développement stable sur votre machine locale.
Auto-hébergement sur le chemin de fer (recommandé pour les projets personnels) : Pour s'auto-héberger l'application Freapi.App, vous pouvez profiter d'un modèle prédéfini qui est facilement disponible. Cliquez ici pour les documents détaillés
Pour exécuter le projet Freapi, suivez ces étapes:
.env dans le dossier racine et copiez le contenu de .env.sample et ajoutez les informations d'identification nécessaires.docker-compose up --build --attach backend
# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodbPour exécuter le projet Freapi localement, suivez ces étapes:
.env dans le dossier racine et copiez le contenu de .env.sample et ajoutez les informations d'identification nécessaires.yarn installyarn startPour s'auto-héberger l'application Freapi.App, vous pouvez profiter d'un modèle prédéfini qui est facilement disponible.
Cliquez sur le bouton ci-dessus pour visiter Railway.app.
Cliquez sur le bouton Déploier maintenant .
(Facultatif) Connectez-vous avec GitHub à déployer.
Remplissez les détails du référentiel:
Pour les variables d'environnement, nous avons fourni certaines valeurs par défaut dans l' ENV pour réduire la charge, mais certains paramètres sont obligatoires:
PORT : Ne modifiez pas la valeur, laissez-le être défini sur 8080 pour afficher les documents Swagger après le déploiement.MONGODB_URI : Fournissez l'URL de la base de données MongoDB Atlas. Un exemple est pré-rempli pour vous, modifiez-le / mettez-le pour continuer.NODE_ENV : défaut par défaut sur «développement» pour afficher les journaux. Vous pouvez choisir de le changer en «production» (assurez-vous d'ajouter exactement le même mot) pour les cacher.EXPRESS_SESSION_SECRET : il est conseillé de modifier la valeur par défaut en votre propre valeur secrète.ACCESS_TOKEN_SECRET : il est conseillé de modifier la valeur par défaut en votre propre valeur secrète.ACCESS_TOKEN_EXPIRY : réglé sur 1 jour par défaut.REFRESH_TOKEN_SECRET : il est conseillé de modifier la valeur par défaut en votre propre valeur secrète.REFRESH_TOKEN_EXPIRY : réglé sur 10 jours par défaut.FREEAPI_HOST_URL : Réglez-le en tant qu'URL de chemin de fer générée.Une fois que vous avez rempli les paramètres de l'environnement requis, si vous choisissez d'ajouter d'autres tels que PayPal, Google et Razorpay, veuillez procéder pour mentionner vos informations d'identification dans le formulaire.
Cliquez sur le bouton Déploier pour déclencher la première version.
Remarque: Une fois l'application déployée, veuillez attendre 3 à 5 minutes pour que les documents Swagger soient disponibles.
Pour assurer la fiabilité et la stabilité de nos utilisateurs finaux, nous utilisons le dramaturge, un framework de test puissant pour automatiser les tests sur tous les points de terminaison.
Assurez-vous d'ajouter MONGO_MEMORY_SERVER_PORT=10000 (port MongoDB pour les tests E2E) dans votre fichier .env .
yarn start:test-serveryarn test:playwrightCela générera un rapport de dramaturge. Pour afficher ce rapport, exécutez la commande suivante
yarn playwright show-reportAssurez-vous que tous les cas de test sont passés chaque fois que vous apportez des modifications.
Nous nous félicitons de votre intérêt à contribuer à notre projet open source!
Pour contribuer à Freapi, veuillez suivre ces étapes:
git checkout -b feat/your-feature-name ou git checkout -b fix/your-bug-fix-name et apportez vos modifications.git commit -am 'add your commit message'git push origin feat/your-feature-name .Voici un guide sur la façon dont vous pouvez contribuer efficacement à notre hub API:
Faire des demandes de mises à jour ReadMe: veuillez vous abstenir d'envoyer des demandes de traction uniquement pour mettre à jour le fichier ReadMe du projet. Bien que nous apprécions l'importance d'une documentation claire et concise, nous préférons nous concentrer sur les contributions substantielles du code et les améliorations des fonctionnalités.
Mises à jour de la grammaire: notre équipe valorise une communication efficace, mais nous ne sommes pas des stickers de grammaire. Vous n'avez pas besoin d'envoyer des demandes de traction uniquement pour les correctifs de grammaire ou les améliorations du langage mineures. Au lieu de cela, concentrez-vous sur les fonctionnalités et les caractéristiques de base du projet.
Évitez de mettre à jour les API publiques existantes: pour maintenir la stabilité et la cohérence, nous décourageons les mises à jour directes des API publiques existantes dans le centre API. Ces API ont été soigneusement testées et approuvées. Cependant, si vous rencontrez des bogues ou des problèmes, nous vous encourageons à ouvrir un problème sur le tracker de problèmes de notre projet à nous en informer.
Construisez de nouvelles API du projet: nous vous encourageons à explorer votre créativité et à contribuer en créant des API complètes du projet. Ces API devraient fournir des solutions complètes qui peuvent aider les développeurs à construire des projets complexes pour présenter leurs compétences et leurs capacités. Vos contributions dans ce domaine profiteront grandement à la communauté.
Rédiger une proposition et discuter de Discord: Avant de plonger dans votre projet, nous vous recommandons de rédiger une proposition. Cela peut inclure une carte mentale ou un contour de l'API que vous avez l'intention de construire et ses avantages potentiels. Rejoignez notre communauté Discord, où vous pouvez partager votre proposition, discuter des idées et recueillir des commentaires de collègues contributeurs. S'engager dans ces discussions améliorera votre portefeuille backend et aidera à façonner l'orientation future du projet.
Nous apprécions votre enthousiasme et attendons avec impatience vos précieuses contributions à notre projet Open Source API Hub.
Ensemble, nous pouvons favoriser un environnement collaboratif et avoir un impact significatif dans le paysage de l'intégration de l'API.
Cliquez ici pour un guide de contribution détaillé.
Merci de votre intérêt à contribuer au projet Freapi en créant des applications frontales consommant Freapis! Vos efforts jouent un rôle crucial dans l'amélioration de l'expérience utilisateur et l'élargissement de la portée de nos API. Veuillez suivre ce guide pour assurer un processus de contribution en douceur et collaboratif.
Cliquez ici pour un guide de contribution détaillé pour les développeurs de frontend!
Merci de votre intérêt à contribuer au projet Freapi pour augmenter la couverture du code de notre service API qui nous aide à expédier des points de terminaison robustes qui sont testés sur le champ de bataille. Veuillez suivre ce guide pour assurer un processus de contribution en douceur et collaboratif.
Cliquez ici pour un guide de contribution détaillé pour augmenter la couverture du code.
Swagger Docs: https://api.freeapi.app
Remarque: les documents Swagger sont générés automatiquement à partir du fichier swagger.yaml . Lors de l'exécution du projet localement, assurez-vous de changer l'URL en http://localhost:<port_from_.env>/api/v1 dans le champ Swagger Docs servers/url .
