apihub
v1.3.0
Wir versuchen, einen einzelnen Quell -API -Hub zu erstellen, mit dem in jeder Programmiersprache API -Handhabung gelernt werden kann. Benutzer können ihr Front -End -Portfolio in Web- und Mobile -Apps mit diesem API -Hub erstellen.
Das Freeapi-Projekt ist eine innovative und gemeindenahe Initiative, die den Entwicklern kostenlose und zugängliche APIs für ihre Projekte zur Verfügung stellt.
Das Projekt konzentriert sich auf die Bereitstellung einer breiten Palette von APIs, die verschiedene Bereiche und Funktionen bedienen und es Entwicklern ermöglichen, diese APIs nahtlos in ihre Anwendungen zu integrieren.
Zu den wichtigsten Highlights des Freeapi -Projekts gehören:
Barrierefreiheit: Das Freeapi -Projekt ist verpflichtet, Hindernisse zu beseitigen, indem er freien Zugang zu seiner APIs -Sammlung bietet. Entwickler können diese APIs ohne Kosteneinschränkungen nutzen und es ihnen ermöglichen, innovative Anwendungen zu experimentieren, zu lernen und aufzubauen.
Verschiedene API -Sammlung: Das Projekt bietet eine vielfältige und umfassende Sammlung von APIs, die sich in verschiedenen Branchen, Domänen und Funktionen erstrecken. Unabhängig davon, ob Sie Social -Media -Integrationen, Zahlungsgateways, Algorithmen für maschinelles Lernen oder IoT -Gerätekonnektivität benötigen, haben Sie das Freeapi -Projekt abgedeckt.
Vereinfachte Integration: Das Freeapi -Projekt versteht die Herausforderungen, denen sich Entwickler bei der Integration von APIs in ihre Anwendungen gegenübersehen. Um dies zu beheben, enthält das Projekt klare Dokumentation, Codeproben und SDKs, die den Integrationsprozess vereinfacht und die Entwicklungszeit und -aufwand verkürzt.
Community-gesteuerte Entwicklung: Das Projekt fördert eine lebendige und kollaborative Gemeinschaft von Entwicklern. Mitwirkenden werden ermutigt, ihr Wissen zu teilen, sich an Diskussionen zu beteiligen und an API-bezogenen Projekten zusammenzuarbeiten. Diese kollektive Bemühungen stellt die kontinuierliche Verbesserung und Zuverlässigkeit der vom Freeapi -Projekt angebotenen APIs sicher.
Lern- und Fähigkeitsentwicklung: Das Freeapi -Projekt zielt darauf ab, Entwickler durch eine Plattform für das Lernen und die Entwicklung von Fähigkeiten zu befähigen. Durch den Zugang zu verschiedenen APIs und Bildungsressourcen können Entwickler ihr Verständnis der API -Integration verbessern, ihr Wissen erweitern und ihr Fachwissen durch den Aufbau vollständiger Projekte präsentieren.
Insgesamt ist das Freeapi -Projekt eine wertvolle Ressource für Entwickler, die zugängliche und vielfältige APIs suchen.
Durch die Förderung einer unterstützenden Gemeinschaft ermöglicht das Projekt Entwicklern, zu lernen, zu schaffen und zu innovieren, was letztendlich zum Wachstum und zur Fortschritt der API -Integrationslandschaft beiträgt.
Einführung unseres bahnbrechenden Open -Source -API -Hub -Projekts, einer dynamischen Plattform, um die Art und Weise zu revolutionieren, wie Entwickler mit APIs interagieren.
Mit Schwerpunkt auf Offenheit, Zugänglichkeit und Lernen befähigt unsere API -Hub Entwickler aller Ebenen, ihre Fähigkeiten in der API -Integration zu erforschen, zu experimentieren und auszubauen.
Highlights:
Open Source: Unser API-Hub basiert auf den Prinzipien von Open Source, um Transparenz, Zusammenarbeit und gemeindenahe Entwicklung zu gewährleisten. Dies bedeutet, dass der Quellcode frei verfügbar ist und es Entwicklern ermöglicht, das Projekt anzupassen, zu erweitern und beizutragen.
Kostenlos zu verwenden: Wir glauben fest daran, die Eintrittsbarrieren zu beseitigen, weshalb unser API -Hub völlig frei zu verwenden ist. Egal, ob Sie ein erfahrener Entwickler sind oder gerade mit Ihrer Codierungsreise beginnen, Sie können unsere Plattform ohne Kostenbeschränkungen nutzen.
Lokal oder Bereitstellung : Flexibilität ist der Kern unseres API -Hubs. Sie haben die Möglichkeit, es lokal zu verwenden, auf Ihrem eigenen Computer auszuführen oder auf einem Server bereitzustellen, wodurch es anderen zugänglich ist. Diese Vielseitigkeit stellt sicher, dass Sie die Plattform an Ihre spezifische Entwicklungsumgebung anpassen können.
Lernressource : Unser API -Hub wurde als umfassende Lernressource konzipiert und bietet eine Fülle von Bildungsmaterialien, Tutorials und Dokumentation. Egal, ob Sie ein Anfänger sind oder Ihr API -Wissen erweitern möchten, unsere Plattform bietet die Ressourcen, die Sie benötigen, um zu lernen und zu verbessern.
Benutzerdefinierte Endpunkte für Anfänger : Für Entwickler auf Anfängerebene bietet unser API-Hub benutzerdefinierte Endpunkte, die ein praktisches Erlebnis bei der Behandlung von API-Antworten bieten. Mit diesen anfängerfreundlichen APIs können Sie sich mit den Grundlagen der Arbeit mit APIs praktizieren und vertraut machen.
Fortgeschrittene APIs für Portfolioaufbau : Zusätzlich zu den Endpunkten auf Anfängernebene bietet unser API-Hub auch erweiterte APIs, um Ihre Fähigkeiten herauszufordern und zu erweitern. Diese APIs ermöglichen es Ihnen, komplexere Integrationsszenarien anzugehen und Ihnen dabei zu helfen, ein robustes Projektportfolio aufzubauen, um Ihr Fachwissen zu demonstrieren.
Durch die Kombination von Open -Source -Prinzipien, Zugänglichkeit und Fokus auf das Lernen ebnet unser API -Hub -Projekt den Weg für Entwickler, in der Welt der API -Integration zu gedeihen. Nehmen Sie an unserer lebendigen Gemeinschaft teil und begeben Sie sich auf eine aufregende Reise der Entdeckung, des Wachstums und der Innovation.
Unser Open-Source-Projekt wird derzeit auf einem Remote-Server gehostet, auf dem wir alle 2 Stunden gezwungen sind, den gesamten Server einschließlich des Dateisystems und der MongoDB-Datenbank zurückzusetzen, um zusätzliche Kosten zu vermeiden.
Dieser Prozess führt zum Löschen aller Bild-/statischen Dateien und zu einem Zurücksetzen der gesamten Datenbank auf dem Server.
Datenverlust: Alle Änderungen, die während des 2-stündigen Intervalls (auf dem Remote-Server), einschließlich hochgeladener Bilder und Benutzerdaten, vorgenommen wurden, sind verloren und nicht wiederherstellbar.
Serviceunterbrechung: Der Server-Reset kann Ihre Entwicklungs- und Testprozesse für eine bestimmte Dauer während des Neustarts des Servers (1-2 Minuten) stören.
Lokale API -Nutzung: Für Entwicklung und Testzwecke empfehlen wir dringend, die API lokal auf Ihrer Maschine durch Klonen des Projekts zu verwenden.
Dies stellt sicher, dass Ihre Arbeit nicht vom Server zurückgesetzt wird, und ermöglicht es Ihnen, eine stabile Entwicklungsumgebung auf Ihrer lokalen Maschine aufrechtzuerhalten.
Selbsthosting an der Eisenbahn (für persönliche Projekte empfohlen) : Um die Freeapi.App-Anwendung selbst zu veranstalten, können Sie eine vorgefertigte Vorlage nutzen, die leicht verfügbar ist. Klicken Sie hier für detaillierte Dokumente
Befolgen Sie die folgenden Schritte, um das Freeapi -Projekt durchzuführen:
.env .env.sampledocker-compose up --build --attach backend
# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodbBefolgen Sie die folgenden Schritte, um das Freeapi -Projekt lokal auszuführen:
.env .env.sampleyarn installyarn startUm die Freeapi.App-Anwendung selbst zu veranstalten, können Sie eine vorgefertigte Vorlage nutzen, die leicht verfügbar ist.
Klicken Sie auf die Schaltfläche oben, um die Eisenbahn zu besuchen.
Klicken Sie jetzt auf die Schaltfläche Bereitstellung .
(Optional) Melden Sie sich mit GitHub an, um bereitzustellen.
Füllen Sie die Details von Repository ein:
Für Umgebungsvariablen haben wir einige Standardwerte in der ENV bereitgestellt, um die Belastung zu verringern, aber einige Parameter sind obligatorisch:
PORT : Ändern Sie den Wert nicht und lassen Sie ihn auf 8080 festgelegt, um die Dokumente nach dem Einsatz anzuzeigen.MONGODB_URI : Geben Sie die MongoDB -Atlas -Datenbank -URL an. Ein Beispiel ist für Sie vorgefüllt. Bearbeiten/aktualisieren Sie es, um fortzufahren.NODE_ENV : Standardsetzt auf "Entwicklung", um die Protokolle anzuzeigen. Sie können es in "Produktion" ändern (genau das gleiche Wort hinzufügen), um sie zu verbergen.EXPRESS_SESSION_SECRET : Es wird empfohlen, den Standardwert auf Ihren eigenen geheimen Wert zu ändern.ACCESS_TOKEN_SECRET : Es wird empfohlen, den Standardwert auf Ihren eigenen geheimen Wert zu ändern.ACCESS_TOKEN_EXPIRY : standardmäßig auf 1 Tag einstellen.REFRESH_TOKEN_SECRET : Es wird empfohlen, den Standardwert auf Ihren eigenen geheimen Wert zu ändern.REFRESH_TOKEN_EXPIRY : Setzen Sie sich standardmäßig auf 10 Tage.FREEAPI_HOST_URL : Stellen Sie es als generierte Eisenbahn -URL ein.Sobald Sie die erforderlichen Umgebungsparameter ausgefüllt haben, fügen Sie Ihre Anmeldeinformationen im Formular zu erwähnen, wenn Sie andere wie Paypal, Google und RazorPay hinzufügen möchten.
Klicken Sie auf die Schaltfläche Bereitstellung , um den ersten Build auszulösen.
Hinweis: Sobald die Bewerbung bereitgestellt ist, warten Sie auf 3-5 Minuten, bis die Swagger-Dokumente verfügbar sind.
Um Zuverlässigkeit und Stabilität für unsere Endbenutzer zu gewährleisten, verwenden wir Dramatiker, ein leistungsstarkes Testframework, um Tests über alle Endpunkte hinweg zu automatisieren.
Stellen Sie in Ihrer .env -Datei MONGO_MEMORY_SERVER_PORT=10000 (MongoDB -Port für E2E -Tests) hinzu.
yarn start:test-serveryarn test:playwrightDies erzeugt einen Dramatikerbericht. Um diesen Bericht anzuzeigen, führen Sie den folgenden Befehl aus
yarn playwright show-reportStellen Sie sicher, dass alle Testfälle nach Abschluss von Änderungen bestanden werden.
Wir begrüßen Ihr Interesse daran, zu unserem Open -Source -Projekt beizutragen!
Um zu Freeapi beizutragen, befolgen Sie bitte die folgenden Schritte:
git checkout -b feat/your-feature-name oder git checkout -b fix/your-bug-fix-name und nehmen Sie Ihre Änderungen vor.git commit -am 'add your commit message'git push origin feat/your-feature-name .Hier finden Sie eine Anleitung, wie Sie effektiv zu unserem API -Hub beitragen können:
Pull -Anfragen für ReadMe -Updates: Bitte senden Sie Pull -Anfragen ausschließlich zur Aktualisierung der Readme -Datei des Projekts. Obwohl wir die Bedeutung klarer und prägnanter Dokumentation zu schätzen wissen, konzentrieren wir uns lieber auf wesentliche Codebeiträge und Merkmalsverbesserungen.
Grammatik -Updates: Unser Team schätzt eine effektive Kommunikation, aber wir sind keine Grammatik -Stickler. Sie müssen keine Pull -Anfragen ausschließlich für Grammatikkorrekturen oder geringfügige Sprachverbesserungen senden. Konzentrieren Sie sich stattdessen auf die Kernfunktionalitäten und Merkmale des Projekts.
Vermeiden Sie die Aktualisierung der vorhandenen öffentlichen APIs: Um Stabilität und Konsistenz aufrechtzuerhalten, entmutigen wir direkte Aktualisierungen der vorhandenen öffentlichen APIs innerhalb des API -Hubs. Diese APIs wurden gründlich getestet und genehmigt. Wenn Sie jedoch auf Fehler oder Probleme stoßen, empfehlen wir Ihnen, ein Problem auf dem Ausgaber -Tracker unseres Projekts zu eröffnen, um uns zu benachrichtigen.
Erstellen Sie neue Projekt -APIs: Wir ermutigen Sie, Ihre Kreativität zu erkunden und einen Beitrag zu erstellen, indem wir vollständige Projekt -APIs erstellen. Diese APIs sollten umfassende Lösungen bieten, mit denen Entwickler komplexe Projekte konstruieren können, um ihre Fähigkeiten und Fähigkeiten zu demonstrieren. Ihre Beiträge in diesem Bereich werden der Community stark zugute kommen.
Entwerfen Sie einen Vorschlag und diskutieren Sie zu Discord: Bevor Sie in Ihr Projekt eintauchen, empfehlen wir, einen Vorschlag zu entwerfen. Dies kann eine Mind Map oder einen Umriss der API und deren potenziellen Vorteile beinhalten. Treten Sie unserer Discord -Community bei, in der Sie Ihren Vorschlag teilen, Ideen diskutieren und Feedback von Mitversorgungskollegen sammeln können. Wenn Sie sich mit diesen Diskussionen befassen, wird Ihr Backend -Portfolio verbessern und die zukünftige Richtung des Projekts gestalten.
Wir schätzen Ihre Begeisterung und freuen uns auf Ihre wertvollen Beiträge zu unserem Open -Source -API -Hub -Projekt.
Gemeinsam können wir ein kollaboratives Umfeld fördern und einen erheblichen Einfluss auf die API -Integrationslandschaft haben.
Klicken Sie hier, um einen detaillierten Beitragsanleitung zu erhalten.
Vielen Dank für Ihr Interesse, zum Freeapi -Projekt beizutragen, indem Sie Frontend -Anwendungen erstellen, die Freeapis konsumieren! Ihre Bemühungen spielen eine entscheidende Rolle bei der Verbesserung der Benutzererfahrung und der Erweiterung der Reichweite unserer APIs. Bitte befolgen Sie diesen Leitfaden, um einen reibungslosen und kollaborativen Beitragsprozess zu gewährleisten.
Klicken Sie hier, um einen detaillierten Beitragsanleitung für Frontend -Entwickler zu erhalten!
Vielen Dank für Ihr Interesse, zum Freeapi -Projekt beizutragen, um die Code -Berichterstattung über unseren API -Dienst zu erhöhen, der uns hilft, robuste Endpunkte zu versenden, die getestet werden. Bitte befolgen Sie diesen Leitfaden, um einen reibungslosen und kollaborativen Beitragsprozess zu gewährleisten.
Klicken Sie hier, um einen detaillierten Beitragsanleitung für die Erhöhung der Codeabdeckung zu erhalten.
Swagger Docs: https://api.freeapi.app
Hinweis: Swagger -Dokumente werden automatisch aus der Datei swagger.yaml generiert. Stellen Sie beim lokalen Ausführen des Projekts sicher, dass Sie die URL in http://localhost:<port_from_.env>/api/v1 im Feld Swagger Docs servers/url ändern.
