关于
Fusio是一个开源的API管理平台,帮助创建创新的API解决方案。
使用场景
- API产品
Fusio帮助你创建出色的API产品,除了构建API外,还提供开发者门户供开发人员注册,以及一种将你的API货币化的方式 - API网关
Fusio可以用作内部API和微服务的网关。它处理所有常见功能,如授权、限速和模式验证 - 单页应用后端
Fusio可以用作构建使用流行JavaScript框架(如Angular、React或Vue)的单页应用的后端。它提供强大的代码生成器,可以自动为你的API生成SDK - 低代码平台
Fusio允许你在不需要编码知识的情况下构建API端点。例如,它提供了一个实体生成器,你可以用它轻松创建完整的CRUD API - API框架
对于更复杂的用例,你还可以将Fusio作为框架来从头开始构建完整的API。这意味着你可以构建自定义操作,在其中使用广泛的PHP生态系统来解决你的任务
功能
Fusio帮助你构建API,提供开箱即用的企业级功能,让你可以专注于你的业务场景。请查看我们的文档网站了解更多信息。以下功能列表给你一个初步概览:
- OpenAPI生成
Fusio自动为定义的路由生成OpenAPI规范 - SDK生成
Fusio可以根据定义的模式自动为你的API生成客户端SDK - Webhook支持
Fusio包含一个webhook系统,有助于为你的API构建发布/订阅功能 - 速率限制
Fusio提供了一种基于用户或应用对请求进行速率限制的方法 - 授权
Fusio使用OAuth2进行API授权 - 货币化
Fusio提供简单的支付系统,可对特定路由收费 - 验证
Fusio使用TypeSchema自动验证传入的请求数据 - 分析
Fusio监控所有API活动并在仪表板上显示它们 - 用户管理
Fusio提供开发者应用,新用户可以通过GitHub、Google、Facebook或普通电子邮件注册登录或注册新账户
应用
Fusio提供许多有助于处理API的应用。大多数应用是简单的JS应用,与Fusio的内部API配合工作。你可以在我们的市场查看所有可用应用的列表。你可以通过CLI命令安装这样的应用,例如php bin/fusio marketplace:install fusio
,或通过后端应用安装。
所有应用都安装在apps/
文件夹中。你需要在.env
文件中通过定义APP_APPS_URL
变量来告诉Fusio应用文件夹的公共URL。根据你的设置,这可以是自定义子域名,如https://apps.acme.com
,或简单的子文件夹https://acme.com/apps
。
后端
后端应用是配置和管理API的主要应用。安装程序会自动安装此应用。该应用位于/apps/fusio/
。
VSCode
Fusio提供VSCode扩展,可用于简化操作开发。这意味着你可以直接在VSCode编辑器内开发每个操作。
SDK
为了构建和集成使用Fusio的应用,我们提供了几个SDK,你可以用它们与Fusio实例配合工作,或者你也可以简单地直接与REST API通信。
语言 | GitHub | 包 | 示例 |
---|---|---|---|
C# | GitHub | NuGet | 示例 |
Go | GitHub | 示例 | |
Java | GitHub | Maven | 示例 |
Javascript | GitHub | NPM | |
PHP | GitHub | Packagist | 示例 |
Python | GitHub | PyPI | 示例 |
框架
REST API
生态系统
Fusio是一个开源项目,你可以在Apache 2.0许可条款下免费用于私人和商业项目。除了我们的核心产品外,我们还提供额外的服务来增强Fusio的功能。
- SDKgen
SDKgen是一个强大的代码生成器,可以自动为你的REST API构建客户端SDK。 - APIgen
根据你的数据模型生成功能完整且可定制的API。 - APImon
APImon提供直观的服务来监控和分析API端点。 - TypeSchema
一种用于以语言中立格式描述数据模型的JSON格式。 - TypeAPI
OpenAPI的替代方案,用于描述REST API以进行类型安全的代码生成。 - TypeHub
一个协作平台,用于设计和构建API模型和客户端SDK。 - PSX
一个创新的PHP框架,专门用于构建完全类型化的REST API。
安装
可以通过composer或手动文件下载安装Fusio。
Composer
composer create-project fusio/fusio
下载
https://github.com/apioo/fusio/releases
配置
您可以按照以下步骤手动安装Fusio,或者使用位于public/install.php
的浏览器安装程序。出于安全考虑,强烈建议在安装完成后删除安装程序脚本。
- 调整配置文件
打开Fusio目录中的.env
文件,将APP_URL
更改为指向public文件夹的域名。同时在APP_CONNECTION
键中填入数据库凭据。如果您想使用应用程序,可以选择调整APP_APPS_URL
为apps文件夹的公共URL。 - 执行安装命令
安装脚本将Fusio数据库架构插入到提供的数据库中。可以使用以下命令执行:php bin/fusio migrate
。 - 创建管理员用户
安装完成后,您需要创建一个新的管理员账户。为此,可以使用以下命令:php bin/fusio adduser
。选择"Administrator"作为账户类型。 - 安装后端应用
要通过管理面板管理您的API,您需要安装后端应用。可以使用以下命令安装应用:php bin/fusio marketplace:install fusio
您可以通过浏览器访问APP_URL
来验证安装。您应该看到一个API响应,表明安装成功。
如果您想在特定数据库上安装Fusio,需要调整APP_CONNECTION
参数。您可以使用以下连接字符串:
- MySQL:
pdo-mysql://root:test1234@localhost/fusio
- PostgreSQL:
pdo-pgsql://postgres:postgres@localhost/fusio
- SQLite:
pdo-sqlite:///fusio.sqlite
理论上,Fusio可以安装在我们的数据库抽象层支持的所有数据库上,但我们的内部测试用例仅涵盖MySQL、PostgreSQL和SQLite,因此无法保证所有功能都能正常工作。
Docker
可以通过docker设置Fusio。这样做的优点是无需配置即可自动获得一个完整运行的Fusio系统。这对于测试和评估特别有用。要设置容器,您需要检出仓库并运行以下命令:
docker-compose up -d
这将构建一个预定义后端账户的Fusio系统。凭据来自docker-compose.yml
中的环境变量FUSIO_BACKEND_USER
、FUSIO_BACKEND_EMAIL
和FUSIO_BACKEND_PW
。如果您计划在互联网上运行容器,必须更改这些凭据。
域名
默认情况下,整个Fusio项目可以托管在单个域名上。在这种设置中,您的API在根目录下提供服务,开发者门户和后端应用直接从/apps文件夹提供服务。这种设置易于使用,因为不需要配置。如果您想在生产环境中运行Fusio,我们建议创建以下子域名结构:
- api.acme.com
仅包含Fusio,提供您的API服务,在这种情况下,您可以从public/文件夹中删除apps/文件夹 - developer.acme.com
包含开发者门户应用,外部开发者可以在此注册 - fusio.acme.com
可选的后端应用,用于管理您的Fusio实例。您也可以将其托管在完全独立的内部域名上,后端应用只需要访问Fusio API。
这当然只是一个建议,您可以自由选择喜欢的域名。
文档
请查看我们的官方文档网站,我们在那里汇集了所有文档资源: https://docs.fusio-project.org/
支持
推广
如果您是博主或杂志,我们很高兴您愿意报道Fusio。请查看我们关于页面的媒体部分,下载官方图标集。如果您有任何问题,请直接给我们发消息,我们可以帮助您创作优质内容。
咨询
如果您是公司或自由职业者,想要了解如何使用Fusio的详细信息,可以联系我们进行咨询。在研讨会中,我们会尝试找到最佳方式让您使用/集成Fusio,同时解释功能并回答您的问题。
捐赠
如果这个项目帮助您创造收入,或者您想支持这个项目,请查看我们仓库中的捐赠选项。
合作伙伴
以下列表显示了Fusio项目的所有合作伙伴。我们感谢每一位支持我们将API开发推向下一个层次的合作伙伴。如果您有兴趣在此列出,欢迎赞助我们的项目。