From 7506fac4105e04be3c7c1525679d01c4bc8e8fe4 Mon Sep 17 00:00:00 2001 From: rolea liu Date: Fri, 16 Aug 2024 18:15:31 +0800 Subject: [PATCH] Update README.md --- README.md | 150 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 98 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 69a38b77..0d61ee8b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ -![image](https://github.com/user-attachments/assets/eefdecf1-de71-4108-9f4e-ba657e4c88ba) +![image](https://github.com/user-attachments/assets/96e36db5-2733-49c8-8e1e-ecbcc60a3943) APIPark 是全球首个开源企业级 API 开放平台，帮助组织快速构建企业内部 API 门户/市场，享受极致的转发性能、API 可观测性、服务治理、多租户管理、订阅审批流程等诸多好处。 +
-## 概述 +# ✨ 快速开始 APIPark 致力于为全球企业提供一站式 API 开放与接入产品，打造新一代 API 资产治理标准。APIPark 使用 Apache 2.0 协议开源。 - -## 为什么选择 APIPark？ APIPark 致力于解决企业在 API 管理中面临的几大关键挑战： - 复杂的 API 调用关系：简化了复杂系统架构中的 API 交互。 - 数据使用跟踪：提供全面的 API 使用监控和报告。 @@ -17,94 +16,141 @@ APIPark 致力于解决企业在 API 管理中面临的几大关键挑战： - 量化数据资产价值：提升数据资产的可见性和估值。 -## 主要功能 -### 集中管理与展示企业内部的所有 API 服务，便于用户快速发现和访问所需的 API -API 服务广场是 APIPark 的核心功能之一，旨在解决企业内部 API 分散、管理混乱的问题。通过 API 服务广场，企业可以将所有的 API 服务集中展示在一个统一的平台上，使得不同部门和团队能够轻松找到并使用所需的 API 服务。 -![image](https://github.com/user-attachments/assets/b3b87074-54bf-42e6-b0c3-2aeb7d6f0ea3) +
+ +😍APIPark 部署非常简单，仅需一句命令行即可在 5 分钟内部署好你的 API 资产开放平台。 + +``` +curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start.sh +``` + +
+ +# 🔥 特性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 集中管理与展示企业内部的所有 API 服务 + + 覆盖 API 从设计、发布、运行、下线的全过程 +
+ + API 服务广场是 APIPark 的核心功能之一，旨在解决企业内部 API 分散、管理混乱的问题。通过 API 服务广场，企业可以将所有的 API 服务集中展示在一个统一的平台上，使得不同部门和团队能够轻松找到并使用所需的 API 服务。 + + + API 全生命周期管理功能帮助企业规范 API 的管理流程，管理 API 的流量转发和负载均衡，并管理所有 API 对外发布的版本。提升 API 的质量和可维护性。通过这个功能，企业可以实现 API 的高效开发和稳定运营，从而支持业务的快速发展和创新。 +
+ 管理多个租户，确保数据隔离和安全 + + API资源需要先申请并等待审核通过才能调用 +
+ + 多租户管理功能为企业提供了在同一平台上管理多个租户的能力，每个租户可以拥有独立的资源、用户和权限设置，确保数据和操作的隔离，帮助提升资源利用效率和管理便捷性。 + + + APIPark 对所有 API 资源提供流程审批功能，避免违规或避开平台来调用API，调用方需要先申请API资源，并等待服务方审核通过后才能正式调用API。 +
+ 通过详细的调用日志，帮助排查API在任意时刻的访问情况 + + 丰富的统计报表* +
+ + API 调用日志功能为企业提供了全面的日志记录能力，详细记录每一次 API 调用的所有相关信息。通过这些日志，企业可以快速追踪和排查 API 调用中的问题，确保系统的稳定运行和数据安全。 + + + 通过对历史调用数据的分析，APIPark 能够展示 API 长期的调用趋势和性能变化，帮助企业在问题发生前进行预防性维护。 +
-### 覆盖 API 从设计、发布、运行、下线的全过程，确保 API 的高质量和稳定性 -API 全生命周期管理功能帮助企业规范 API 的管理流程，管理 API 的流量转发和负载均衡，并管理所有 API 对外发布的版本。提升 API 的质量和可维护性。通过这个功能，企业可以实现 API 的高效开发和稳定运营，从而支持业务的快速发展和创新。 -![image](https://github.com/user-attachments/assets/ad9d6d37-f4f5-465d-91f2-67527f38a672) +
- -### 在一个平台上管理多个租户，确保不同租户之间的数据隔离和安全 -多租户管理功能为企业提供了在同一平台上管理多个租户的能力，每个租户可以拥有独立的资源、用户和权限设置，确保数据和操作的隔离，帮助提升资源利用效率和管理便捷性。 -![image](https://github.com/user-attachments/assets/3012b261-65be-49c6-9ff2-4c75fe55acf5) - - -### API资源需要先申请并等待审核通过才能调用 -APIPark 对所有 API 资源提供流程审批功能，避免违规或避开平台来调用API，调用方需要先申请API资源，并等待服务方审核通过后才能正式调用API。API 订阅审批过程的所有操作都会被详细记录下来，便于日后进行合规审计或安全检查。 -![image](https://github.com/user-attachments/assets/3051df32-d156-4f85-8f1d-8f7edc7d1333) - - -### 通过详细的调用日志，帮助排查API在任意时刻的访问情况 -API 调用日志功能为企业提供了全面的日志记录能力，详细记录每一次 API 调用的所有相关信息。通过这些日志，企业可以快速追踪和排查 API 调用中的问题，确保系统的稳定运行和数据安全。 -![image](https://github.com/user-attachments/assets/282c8894-edc7-4bdd-be32-c84047b2e85c) - - -### 丰富的统计报表 -通过对历史调用数据的分析，APIPark 能够展示 API 长期的调用趋势和性能变化，帮助企业在问题发生前进行预防性维护。 -*该功能将在稍后支持 -![image](https://github.com/user-attachments/assets/e31a3bd0-a23c-468b-8352-7c864da38784) - - - -## 适用场景 -- 提升运营效率 +# 🚩适用场景 +## 提升运营效率 - 快速构建内部 API 门户。 - 高效管理和调用 API。 - 减少复杂的系统间调用关系。 -- 确保合规与安全 +## 确保合规与安全 - 强大的服务治理和合规管理功能。 - 精细化管理应用调用的权限。 - 确保 API 调用的安全性和合规性，降低企业风险。 -- 简化系统故障排查 +## 简化系统故障排查 - 利用监控和故障诊断工具快速发现和解决问题。 - 减少停机时间，提高系统稳定性。 -- 多租户管理和灵活订阅 +## 多租户管理和灵活订阅 - 支持多租户管理，满足不同业务单元需求。 - 灵活的订阅和审批流程简化 API 的使用和管理。 -- 增强 API 可观测性 +## 增强 API 可观测性 - 实时监控和追踪 API 使用情况。 - 全面掌握数据流动，提升数据使用透明度。 -- 提升数据资产价值 +## 提升数据资产价值 - 量化和分析 API 使用情况，更好地评估和提升数据资产价值。 - 为决策提供数据支持。 -## 快速开始, APIPark 帮你在 30 分钟内构建自己的 API 门户 +
+ +# 🚀一键部署 APIPark 部署非常简单，仅需一句命令行即可在 5 分钟内部署好你的 API 资产开放平台。 ``` curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start.sh ``` -## 文档 +
+ +## 📕文档 访问 [APIPark文档](https://docs.apipark.com/docs/install) 获取详细的安装指南、API 参考和使用说明。 +
-## 社区 -加入我们的社区，了解最新的新闻、更新和讨论。 -- Slack -- Twitter - -## 许可证 +## 🧾许可证 APIPark 使用 Apache 2.0 许可证。更多详情请查看 LICENSE 文件。 ---- +
-## 联系我们 +## 💌联系我们 对于企业级功能和专业技术支持，请联系售前专家进行个性化演示、定制方案和获取报价。 - 网站: https://apipark.com - 电子邮件: sales@apipark.com ---- +
感谢您选择 APIPark，下一代 API 资产治理平台。