fusio

Um

Fusio ist eine Open-Source-API-Managementplattform, die bei der Entwicklung innovativer API-Lösungen hilft.

Anwendungsfälle

• API-Produkt
  Fusio hilft Ihnen bei der Erstellung eines großartigen API-Produkts. Neben der Erstellung einer API bietet es ein Entwicklerportal, in dem sich Entwickler registrieren können, und eine Möglichkeit, Ihre API zu monetarisieren
• API-Gateway
  Fusio kann als Gateway zu Ihrer internen API und Ihren Microservices verwendet werden. Es beherrscht alle gängigen Funktionen wie Autorisierung, Ratenbegrenzung und Schema-Validierung
• SPA-Backend
  Fusio kann als Backend zum Erstellen von SPAs mit gängigen Javascript-Frameworks wie Angular, React oder Vue verwendet werden. Es bietet einen leistungsstarken Codegenerator, der automatisch ein SDK für Ihre API generieren kann
• Low-Code-Plattform
  Mit Fusio können Sie API-Endpunkte ohne Programmierkenntnisse erstellen. Das heißt, es stellt einen Entitätsgenerator bereit, mit dem Sie ganz einfach komplette CRUD-APIs erstellen können.
• API-Framework
  Für komplexere Anwendungsfälle können Sie Fusio auch als Framework verwenden, um komplette APIs von Grund auf zu erstellen. Das bedeutet, dass Sie benutzerdefinierte Aktionen erstellen, bei denen Sie das breite PHP-Ökosystem zur Lösung Ihrer Aufgabe nutzen können.

Merkmale

Fusio hilft Ihnen beim Erstellen von APIs, die sofort einsatzbereite Unternehmensfunktionen bieten, damit Sie sich auf Ihren Geschäftsfall konzentrieren können. Weitere Informationen finden Sie auf unserer Dokumentationswebsite. Die folgende Funktionsliste gibt Ihnen einen ersten Überblick:

• OpenAPI-Generierung
  Fusio generiert automatisch eine OpenAPI-Spezifikation für die definierten Routen
• SDK-Generierung
  Fusio kann basierend auf dem definierten Schema automatisch ein Client-SDK für Ihre API generieren
• Webhook-Unterstützung
  Fusio enthält ein Webhook-System, das beim Erstellen von Publish/Subscribe für Ihre API hilft
• Ratenbegrenzung
  Fusio bietet eine Möglichkeit, Limitanfragen basierend auf dem Benutzer oder der App zu bewerten
• Genehmigung
  Fusio verwendet OAuth2 für die API-Autorisierung
• Monetarisierung
  Fusio bietet ein einfaches Zahlungssystem zur Abrechnung bestimmter Strecken
• Validierung
  Fusio verwendet das TypeSchema, um eingehende Anforderungsdaten automatisch zu validieren
• Analytik
  Fusio überwacht alle API-Aktivitäten und zeigt sie auf einem Dashboard an
• Benutzerverwaltung
  Fusio bietet eine Entwickler-App, mit der sich neue Benutzer über GitHub, Google, Facebook oder über die normale E-Mail-Registrierung anmelden oder ein neues Konto registrieren können

Apps

Fusio bietet viele Apps, die die Arbeit mit der API unterstützen. Bei den meisten Apps handelt es sich um einfache JS-Apps, die mit der internen API von Fusio arbeiten. Eine Liste aller verfügbaren Apps finden Sie auf unserem Marktplatz. Sie können eine solche App entweder über einen CLI-Befehl, z. B. php bin/fusio marketplace:install fusio , oder über die Backend-App installieren.

Alle Apps werden im Ordner apps/ installiert. Sie müssen Fusio die öffentliche URL zum Apps-Ordner in der .env Datei mitteilen, indem Sie die Variable APP_APPS_URL definieren. Abhängig von Ihrem Setup kann dies entweder eine benutzerdefinierte Subdomäne wie https://apps.acme.com oder einfach der Unterordner https://acme.com/apps sein.

Backend

Die Backend-App ist die Haupt-App zum Konfigurieren und Verwalten Ihrer API. Das Installationsprogramm installiert diese App automatisch. Die App befindet sich unter /apps/fusio/ .

VSCode

Fusio bietet eine VSCode-Erweiterung, die zur Vereinfachung der Aktionsentwicklung verwendet werden kann. Das bedeutet, dass Sie jede Aktion direkt im VSCode-Editor entwickeln können.

SDK

Um Apps mit Fusio zu erstellen und zu integrieren, stellen wir mehrere SDKs zur Verfügung, die Sie für die Arbeit mit einer Fusio-Instanz verwenden oder einfach manuell mit der REST-API kommunizieren können.

Sprache	GitHub	Paket	Beispiel
C#	GitHub	NuGet	Beispiel
Gehen	GitHub		Beispiel
Java	GitHub	Maven	Beispiel
Javascript	GitHub	NPM
PHP	GitHub	Paketist	Beispiel
Python	GitHub	PyPI	Beispiel

Rahmenwerke

Rahmen	GitHub	Paket	Beispiel
Eckig	GitHub	NPM	Beispiel

REST-API

Domain	Dokumentation	Spezifikation
Backend	ReDoc	OpenAPI
Verbraucher	ReDoc	OpenAPI
System	ReDoc	OpenAPI

Ökosystem

Fusio ist ein Open-Source-Projekt, das Sie unter den Bedingungen der Apache 2.0-Lizenz für private und kommerzielle Projekte frei nutzen können. Neben unserem Kernprodukt bieten wir zusätzliche Dienstleistungen an, um die Funktionalität von Fusio zu erweitern.

• SDKgen
  SDKgen ist ein leistungsstarker Codegenerator zum automatischen Erstellen von Client-SDKs für Ihre REST-API.
• APIgen
  Generieren Sie voll funktionsfähige und anpassbare APIs basierend auf Ihrem Datenmodell.
• APImon
  APImon bietet einen intuitiven Service zur Überwachung und Analyse von API-Endpunkten.
• TypeSchema
  Ein JSON-Format zur Beschreibung von Datenmodellen in einem sprachneutralen Format.
• TypeAPI
  Eine OpenAPI-Alternative zur Beschreibung von REST-APIs für die typsichere Codegenerierung.
• TypeHub
  Eine kollaborative Plattform zum Entwerfen und Erstellen von API-Modellen und Client-SDKs.
• PSX
  Ein innovatives PHP-Framework zum Erstellen vollständig typisierter REST-APIs.

Installation

Es ist möglich, Fusio entweder über Composer oder manuell per Dateidownload zu installieren.

Komponist

 composer create-project fusio/fusio

Herunterladen

https://github.com/apioo/fusio/releases

Konfiguration

Sie können Fusio entweder manuell mit den folgenden Schritten installieren oder auch das browserbasierte Installationsprogramm unter public/install.php verwenden. Beachten Sie, dass aus Sicherheitsgründen dringend empfohlen wird, das Installationsskript nach der Installation zu entfernen.

• Passen Sie die Konfigurationsdatei an
  Öffnen Sie die Datei .env im Fusio-Verzeichnis und ändern Sie die APP_URL in die Domäne, die auf den öffentlichen Ordner verweist. Fügen Sie außerdem die Datenbankanmeldeinformationen in die APP_CONNECTION -Schlüssel ein. Passen Sie optional APP_APPS_URL an die öffentliche URL des Apps-Ordners an (falls Sie Apps verwenden möchten).
• Führen Sie den Installationsbefehl aus
  Das Installationsskript fügt das Fusio-Datenbankschema in die bereitgestellte Datenbank ein. Es kann mit dem folgenden Befehl php bin/fusio migrate ausgeführt werden.
• Erstellen Sie einen Administratorbenutzer
  Nach Abschluss der Installation müssen Sie ein neues Administratorkonto erstellen. Hierzu können Sie den folgenden Befehl php bin/fusio adduser verwenden. Wählen Sie als Kontotyp „Administrator“.
• Backend-App installieren
  Um Ihre API über ein Admin-Panel zu verwalten, müssen Sie die Backend-App installieren. Die App kann mit dem folgenden Befehl php bin/fusio marketplace:install fusio installiert werden

Sie können die Installation überprüfen, indem Sie die APP_URL mit einem Browser aufrufen. Sie sollten eine API-Antwort sehen, dass die Installation erfolgreich war.

Wenn Sie Fusio auf einer bestimmten Datenbank installieren möchten, müssen Sie den Parameter APP_CONNECTION anpassen. Sie können die folgenden Verbindungszeichenfolgen verwenden:

• MySQL: pdo-mysql://root:test1234@localhost/fusio
• PostgreSQL: pdo-pgsql://postgres:postgres@localhost/fusio
• SQLite: pdo-sqlite:///fusio.sqlite

Im Allgemeinen ist es möglich, Fusio auf allen Datenbanken zu installieren, die von unserer Datenbankabstraktionsschicht unterstützt werden. Unsere internen Testfälle decken jedoch nur MySQL, PostgreSQL und SQLite ab, sodass es keine Garantie dafür gibt, dass alles funktioniert.

Docker

Es ist möglich, Fusio über Docker einzurichten. Dies hat den Vorteil, dass Sie ohne Konfiguration automatisch ein komplett lauffähiges Fusio-System erhalten. Dies eignet sich besonders gut zum Testen und Bewerten. Um den Container einzurichten, müssen Sie das Repository auschecken und den folgenden Befehl ausführen:

 docker-compose up -d

Dadurch wird das Fusio-System mit einem vordefinierten Backend-Konto erstellt. Die Anmeldeinformationen werden den Umgebungsvariablen FUSIO_BACKEND_USER , FUSIO_BACKEND_EMAIL und FUSIO_BACKEND_PW in docker-compose.yml entnommen. Wenn Sie planen, den Container im Internet auszuführen, müssen Sie diese Anmeldeinformationen ändern.

Domänen

Standardmäßig kann das gesamte Fusio-Projekt auf einer einzigen Domäne gehostet werden. In diesem Setup wird Ihre API im Stammverzeichnis bereitgestellt und das Entwicklerportal und die Backend-Apps werden direkt aus dem Ordner /apps bereitgestellt. Dieses Setup ist einfach zu verwenden, da keine Konfiguration erforderlich ist. Wenn Sie Fusio in einer Produktionsumgebung ausführen möchten, empfehlen wir die Erstellung der folgenden Subdomänenstruktur:

• api.acme.com
  Enthält nur Fusio, wo Ihre API bereitgestellt wird. In diesem Fall können Sie den Ordner „apps/“ aus dem Ordner „public/“ löschen
• Developer.acme.com
  Enthält die Entwicklerportal-App, in der sich externe Entwickler registrieren können
• fusio.acme.com
  Optional die Backend-App, mit der Sie Ihre Fusio-Instanz verwalten können. Sie können dies auch auf einer komplett separaten internen Domäne hosten, die Backend-App benötigt lediglich Zugriff auf die Fusio-API.

Dies ist natürlich nur ein Vorschlag und Sie können die Domainnamen frei wählen, wie Sie möchten.

Dokumentation

Bitte schauen Sie sich unsere offizielle Dokumentations-Website an, auf der wir alle Dokumentationsressourcen bündeln: https://docs.fusio-project.org/

Unterstützung

Förderung

Wenn Sie Blogger oder Zeitschrift sind, würden wir uns freuen, wenn Sie über Fusio berichten möchten. Bitte werfen Sie einen Blick auf den Medienbereich unserer About-Seite, um das offizielle Icon-Set herunterzuladen. Wenn Sie Fragen haben, schreiben Sie uns bitte direkt eine Nachricht, damit wir Ihnen bei der Erstellung großartiger Inhalte helfen können.

Beratung

Wenn Sie ein Unternehmen oder Freiberufler sind und detaillierte Informationen zur Nutzung von Fusio erhalten möchten, können Sie uns für eine Beratung kontaktieren. Im Workshop versuchen wir herauszufinden, wie Sie Fusio am besten nutzen/integrieren können, außerdem versuchen wir, die Funktionalität zu erklären und Ihre Fragen zu beantworten.

Spenden

Wenn Ihnen dieses Projekt hilft, Einnahmen zu generieren, oder wenn Sie das Projekt allgemein unterstützen möchten, schauen Sie sich bitte die Spendenoptionen in unserem Repository an.

Partner

Die folgende Liste zeigt alle Partner des Fusio-Projekts. Wir danken allen Partnern, die uns bei unserer Vision unterstützen, die API-Entwicklung auf die nächste Stufe zu heben. Wenn Sie daran interessiert sind, hier aufgeführt zu werden, können Sie unser Projekt gerne sponsern.