fusio

À propos

Fusio est une plateforme de gestion d'API open source qui permet de créer des solutions API innovantes.

Cas d'utilisation

• Produit API
  Fusio vous aide à créer un excellent produit API. En plus de créer une API, il fournit un portail de développement où les développeurs peuvent s'inscrire et un moyen de monétiser votre API.
• Passerelle API
  Fusio peut être utilisé comme passerelle vers votre API interne et vos microservices. Il gère toutes les fonctionnalités courantes telles que l'autorisation, la limitation de débit et la validation de schéma.
• SPA-Backend
  Fusio peut être utilisé comme backend pour créer des SPA à l'aide de frameworks Javascript populaires tels que Angular, React ou Vue. Il fournit un puissant générateur de code qui peut générer automatiquement un SDK pour votre API
• Plateforme Low-Code
  Fusio vous permet de créer des points de terminaison d'API sans connaissances en codage. C'est-à-dire qu'il fournit un générateur d'entités que vous pouvez utiliser pour créer facilement des API CRUD complètes.
• Cadre API
  Pour des cas d'utilisation plus complexes, vous pouvez également utiliser Fusio comme framework pour créer des API complètes à partir de zéro. Cela signifie que vous créez des actions personnalisées dans lesquelles vous pouvez utiliser le vaste écosystème PHP pour résoudre votre tâche.

Caractéristiques

Fusio vous aide à créer des API fournissant des fonctionnalités d'entreprise prêtes à l'emploi afin que vous puissiez vous concentrer sur votre analyse de rentabilisation. Veuillez consulter notre site Web de documentation pour plus d’informations. La liste des fonctionnalités suivante vous donne un premier aperçu :

• Génération OpenAPI
  Fusio génère automatiquement une spécification OpenAPI pour les routes définies
• Génération de SDK
  Fusio peut générer automatiquement un SDK client pour votre API basé sur le schéma défini
• Prise en charge des webhooks
  Fusio contient un système de webhook qui permet de créer des publications/abonnements pour votre API
• Limitation du débit
  Fusio fournit un moyen d'évaluer les demandes de limite en fonction de l'utilisateur ou de l'application
• Autorisation
  Fusio utilise OAuth2 pour l'autorisation API
• Monétisation
  Fusio fournit un système de paiement simple pour facturer des itinéraires spécifiques
• Validation
  Fusio utilise TypeSchema pour valider automatiquement les données des demandes entrantes
• Analytique
  Fusio surveille toutes les activités de l'API et les affiche sur un tableau de bord
• Gestion des utilisateurs
  Fusio fournit une application de développement où les nouveaux utilisateurs peuvent se connecter ou enregistrer un nouveau compte via GitHub, Google, Facebook ou via une inscription normale par courrier électronique.

Applications

Fusio fournit de nombreuses applications qui aident à travailler avec l'API. La plupart des applications sont de simples applications JS, qui fonctionnent avec l'API interne de Fusio. Vous pouvez voir une liste de toutes les applications disponibles sur notre marché. Vous pouvez installer une telle application soit via une commande CLI, c'est-à-dire php bin/fusio marketplace:install fusio soit via l'application backend.

Toutes les applications sont installées dans le dossier apps/ . Vous devez indiquer à Fusio l'URL publique du dossier apps dans le fichier .env en définissant la variable APP_APPS_URL . En fonction de votre configuration, il peut s'agir soit d'un sous-domaine personnalisé tel que https://apps.acme.com , soit simplement du sous-dossier https://acme.com/apps .

Back-end

L'application backend est l'application principale pour configurer et gérer votre API. Le programme d'installation installe automatiquement cette application. L'application se trouve dans /apps/fusio/ .

VSCode

Fusio fournit une extension VSCode qui peut être utilisée pour simplifier le développement d'actions. Cela signifie que vous pouvez développer chaque action directement dans l'éditeur VSCode.

SDK

Pour créer et intégrer des applications avec Fusio, nous fournissons plusieurs SDK que vous pouvez utiliser pour travailler avec une instance Fusio ou vous pouvez également simplement parler manuellement à l'API REST.

Langue	GitHub	Emballer	Exemple
C#	GitHub	NuGet	Exemple
Aller	GitHub		Exemple
Java	GitHub	Maven	Exemple
Javascript	GitHub	MNP
PHP	GitHub	Packagiste	Exemple
Python	GitHub	PyPI	Exemple

Cadres

Cadre	GitHub	Emballer	Exemple
Angulaire	GitHub	MNP	Exemple

API REST

Domaine	Documentation	Spécification
Back-end	ReDoc	OuvrirAPI
Consommateur	ReDoc	OuvrirAPI
Système	ReDoc	OuvrirAPI

Écosystème

Fusio est un projet open source que vous pouvez utiliser librement pour des projets privés et commerciaux selon les termes de la licence Apache 2.0. Outre notre produit principal, nous proposons des services supplémentaires pour augmenter les fonctionnalités de Fusio.

• SDKgén
  SDKgen est un puissant générateur de code permettant de créer automatiquement des SDK clients pour votre API REST.
• APIgen
  Générez des API entièrement fonctionnelles et personnalisables basées sur votre modèle de données.
• APImon
  APImon fournit un service intuitif pour surveiller et analyser les points de terminaison de l'API.
• TypeSchéma
  Un format JSON pour décrire les modèles de données dans un format neutre en termes de langage.
• TypeAPI
  Une alternative OpenAPI pour décrire les API REST pour la génération de code sécurisé.
• TypeHub
  Une plateforme collaborative pour concevoir et créer des modèles d'API et des SDK clients.
• PSX
  Un framework PHP innovant dédié à la construction d'API REST entièrement typées.

Installation

Il est possible d'installer Fusio soit via Composer, soit en téléchargeant manuellement un fichier.

Compositeur

 composer create-project fusio/fusio

Télécharger

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

Configuration

Vous pouvez soit installer manuellement Fusio en suivant les étapes ci-dessous, soit utiliser le programme d'installation basé sur un navigateur à public/install.php . Notez que pour des raisons de sécurité, il est fortement recommandé de supprimer le script d'installation après l'installation.

• Ajuster le fichier de configuration
  Ouvrez le fichier .env dans le répertoire Fusio et remplacez l' APP_URL par le domaine pointant vers le dossier public. Insérez également les informations d'identification de la base de données dans les clés APP_CONNECTION . Facultatif, ajustez APP_APPS_URL à l'URL publique du dossier des applications (au cas où vous souhaiteriez utiliser des applications).
• Exécutez la commande d'installation
  Le script d'installation insère le schéma de la base de données Fusio dans la base de données fournie. Il peut être exécuté avec la commande suivante php bin/fusio migrate .
• Créer un utilisateur administrateur
  Une fois l'installation terminée, vous devez créer un nouveau compte administrateur. Pour cela, vous pouvez utiliser la commande suivante php bin/fusio adduser . Choisissez comme type de compte "Administrateur".
• Installer l'application back-end
  Pour gérer votre API via un panneau d'administration, vous devez installer l'application backend. L'application peut être installée avec la commande suivante php bin/fusio marketplace:install fusio

Vous pouvez vérifier l'installation en visitant l' APP_URL avec un navigateur. Vous devriez voir une réponse de l'API indiquant que l'installation a réussi.

Si vous souhaitez installer Fusio sur une base de données spécifique, vous devez ajuster le paramètre APP_CONNECTION . Vous pouvez utiliser les chaînes de connexion suivantes :

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

En général, il est possible d'installer Fusio sur toutes les bases de données prises en charge par notre couche d'abstraction de base de données, mais nos cas de tests internes ne couvrent que MySQL, PostgreSQL et SQLite, il n'y a donc aucune garantie que tout fonctionne.

Docker

Il est possible de configurer Fusio via Docker. Cela présente l'avantage que vous obtenez automatiquement un système Fusio complet en cours d'exécution sans configuration. Ceci est particulièrement utile pour les tests et l’évaluation. Pour configurer le conteneur, vous devez extraire le référentiel et exécuter la commande suivante :

 docker-compose up -d

Cela construit le système Fusio avec un compte backend prédéfini. Les informations d'identification sont extraites des variables d'environnement FUSIO_BACKEND_USER , FUSIO_BACKEND_EMAIL et FUSIO_BACKEND_PW dans le docker-compose.yml . Si vous envisagez d'exécuter le conteneur sur Internet, vous devez modifier ces informations d'identification.

Domaines

Par défaut, le projet Fusio complet peut être hébergé sur un seul domaine. Dans cette configuration, votre API est servie dans le répertoire racine et le portail des développeurs et les applications backend sont directement servis à partir du dossier /apps. Cette configuration est facile à utiliser puisqu’elle ne nécessite aucune configuration. Si vous souhaitez exécuter Fusio dans un environnement de production, nous vous recommandons de créer la structure de sous-domaines suivante :

• api.acme.com
  Contient uniquement Fusio où votre API est servie, dans ce cas vous pouvez supprimer le dossier apps/ du dossier public/
• développeur.acme.com
  Contient l'application du portail des développeurs où les développeurs externes peuvent s'inscrire
• fusio.acme.com
  En option, l'application backend où vous pouvez gérer votre instance Fusio. Vous pouvez également l'héberger sur un domaine interne complètement distinct, l'application backend n'a besoin que d'accéder à l'API Fusio.

Ceci n'est bien sûr qu'une suggestion et vous êtes libre de choisir les noms de domaine qui vous conviennent.

Documentation

Veuillez consulter notre site Web de documentation officiel où nous regroupons toutes les ressources de documentation : https://docs.fusio-project.org/

Soutien

Promotion

Si vous êtes un blogueur ou un magazine, nous serions heureux si vous souhaitez couvrir Fusio. Veuillez jeter un œil à la section Médias de notre page À propos pour télécharger le jeu d'icônes officiel. Si vous avez des questions, écrivez-nous directement un message afin que nous puissions vous aider à créer un contenu de qualité.

Consultant

Si vous êtes une entreprise ou un indépendant et souhaitez obtenir des informations détaillées sur la manière d'utiliser Fusio, vous pouvez nous contacter pour une consultation. Dans l'atelier, nous essayons de trouver la meilleure façon d'utiliser/intégrer Fusio, nous essayons également d'expliquer la fonctionnalité et de répondre à vos questions.

Dons

Si ce projet vous aide à générer des revenus ou en général si vous souhaitez soutenir le projet, veuillez consulter les options de don sur notre référentiel.

Partenaire

La liste suivante présente tous les partenaires du projet Fusio. Nous tenons à remercier tous les partenaires qui nous soutiennent dans notre vision de faire passer le développement d'API au niveau supérieur. Si vous souhaitez être répertorié ici, n'hésitez pas à parrainer notre projet.