From 060a719244aaa2d9c1d54ab228308fcbf403fc32 Mon Sep 17 00:00:00 2001 From: Addison Schultz Date: Mon, 10 Feb 2025 07:10:07 +0000 Subject: [PATCH 1/4] GITBOOK-1: Restructure docs --- .../version-1.4-beta/README.md | 159 +++++++++++++ .../version-1.4-beta/SUMMARY.md | 32 +++ .../version-1.4-beta/ai/README.md | 2 + .../version-1.4-beta/developer_portal.md | 26 +-- .../version-1.4-beta/overview.md | 211 ------------------ .../version-1.4-beta/services/README.md | 2 + .../version-1.4-beta/system_setting/README.md | 2 + 7 files changed, 210 insertions(+), 224 deletions(-) create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/SUMMARY.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md delete mode 100644 i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/overview.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md new file mode 100644 index 0000000..488aa6e --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md @@ -0,0 +1,159 @@ +--- +sidebar_position: 1 +title: 🦄 Overview +--- + +# Overview + +## APIPark + +![APIPark](images/Banner.png) + +**🦄APIPark is an open-source, all-in-one AI gateway and API developer portal designed to help developers and businesses easily manage, integrate, and deploy AI services. Based on the Apache 2.0 protocol, APIPark is open-source and can be used for commercial purposes for free!** + +✨With APIPark, you can achieve the following: + +1. Quickly integrate over 100 AI models; we support all major AI companies! +2. Combine AI models and prompts into APIs, such as creating a sentiment analysis API, translation API, or data analysis API with OpenAI GPT4o and some custom prompts. +3. Standardize the request data format for all AI APIs, so switching AI models or modifying prompts won't affect your app or microservices, simplifying AI usage and maintenance. +4. Share APIs within your team through the APIPark developer portal. +5. Manage applications and API keys to ensure the security and stability of your APIs. +6. Monitor your AI API usage with clear charts. +7. Quickly output API request logs to third-party log platforms. + +![](images/2024-12-18/f9b31736882f149766c86bfe25f2a351c95f73606cfb80a3cb79ca7049d128cc.png)\ +\ + + +✨APIPark is also a powerful cloud-native API gateway: + +1. It offers higher performance than Nginx and supports cluster deployment to handle large-scale traffic. +2. Share and manage REST APIs within your team to avoid management costs and data leakage issues due to chaotic API calls. + +\ + + +## 💌 Why did we create APIPark? + +Before creating APIPark, we spent seven years developing an API development and automated testing platform, Eolink, with over 1 million developer users. We have over 500 corporate clients and received multi-million yuan investment from Sequoia Capital. + +With the development of AI and Agents, we found many enterprises wanted to integrate AI into internal systems and third-party APIs to enable AI Agents to perform more complex tasks, not just act as Q\&A bots. Thus, we created APIPark, your one-stop AI gateway and API developer portal, to accelerate your AI API development and quickly build your products or AI Agents! + +\ + + +## ✨ Quick Start + +APIPark aims to solve the following problems: + +* Seamlessly integrate various large AI models and package these AI capabilities into APIs for easy calling, simplifying the threshold for using AI models. +* Manage complex AI & API call relationships. +* Manage API creation, monitoring, and security. +* Fault detection and troubleshooting: simplify system issue identification and resolution. +* Quantify data asset value: enhance data asset visibility and valuation. + +\ + + +😍 Deploying APIPark is straightforward; you can set up your AI gateway and API developer portal within 5 minutes with just one command line. + +``` +curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start.sh +``` + +\ + + +## 🔥 Features + +| Quickly Integrate 100+ AI Models | Call All AI Using a Unified API Format | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| ![](https://apipark.com/wp-content/uploads/2024/10/AI-Gateway.png) | ![](https://apipark.com/wp-content/uploads/2024/10/Unified-API.png) | +| One-Click Prompt to REST API Conversion | Quickly Share APIs Within Teams | +| ![](https://apipark.com/wp-content/uploads/2024/10/Prompt-template.png) | ![](https://apipark.com/wp-content/uploads/2024/10/developer-portal.png) | +| Performance Rivaling Nginx | Complete API Design, Release, Call, Decommissioning in One Place | +| ![](https://apipark.com/wp-content/uploads/2024/10/hyper-performance.png) | ![](https://apipark.com/wp-content/uploads/2024/08/Life-Cycle.png) | +| Approve API Call Requests from Tenants | Multi-Tenant Management | +| ![](https://apipark.com/wp-content/uploads/2024/08/Application.png) | ![](https://apipark.com/wp-content/uploads/2024/08/Multi-tenant.png) | +| Detailed Logging of All API Calls | Powerful Data Analysis | +| ![](https://apipark.com/wp-content/uploads/2024/08/Chart-1.png) | ![](https://apipark.com/wp-content/uploads/2024/08/Chart.png) | + +\ + + +## 🚀 Use Cases + +### Simplify AI Integration Cost + +* Connect to over 100 major models from mainstream AI vendors with a unified API call, without extra adaptation work. +* Create new AI APIs by combining AI models and prompts, simplifying AI API development. +* Quickly share AI APIs within the team. + +### Improve Operational Efficiency + +* Rapidly build an internal API developer portal. +* Efficiently manage and call APIs. +* Reduce complex inter-system call relationships. + +### Ensure Compliance and Security + +* Strong service governance and compliance management features. +* Granular management of application call permissions. +* Ensure the security and compliance of API calls, reducing enterprise risk. + +### Simplify System Troubleshooting + +* Quickly detect and resolve issues using monitoring and fault diagnosis tools. +* Reduce downtime and improve system stability. + +### Multi-Tenant Management and Flexible Subscription + +* Supports multi-tenant management, catering to different business unit needs. +* Flexible subscription and approval processes simplify API usage and management. + +### Enhance API Observability + +* Real-time monitoring and tracking of API usage. +* Comprehensive understanding of data flow, enhancing data usage transparency. + +\ + + +## 🚩 Roadmap + +We have exciting goals for APIPark: enabling everyone to quickly create their products and AI Agents with AI and APIs! + +To achieve this, we plan to add new features to APIPark: + +1. Integrate API markets like Postman, RapidAPI, APISpace, APILayer, etc. You can use APIs from various markets directly through APIPark and make them smarter with AI. +2. Integrate AI Agents like Langchain, AgentGPT, Auto-GPT, Dify, etc., allowing AI Agents to access your internal systems or third-party APIs via APIPark for more complex tasks. +3. Intelligent API Orchestration, offering a unified API entry through APIPark to automatically orchestrate multiple APIs based on your request content to meet your needs. + +\ + + +## 📕 Documentation + +Visit [APIPark Documentation](https://docs.apipark.com/docs/install) for detailed installation guides, API references, and usage instructions. + +\ + + +## 🧾 License + +APIPark uses the Apache 2.0 license. For more details, please check the LICENSE file. + +\ + + +## 💌 Contact Us + +For enterprise-level features and professional technical support, please contact our pre-sales experts for personalized demonstrations, customized solutions, and quotes. + +* Website: https://apipark.com +* Email: contact@apipark.com + +\ + + +🙏 Thank you to everyone who helped shape APIPark. We are excited to hear from the community! Let's make the world of APIs and AI stronger and more exciting together. 🎉 diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/SUMMARY.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/SUMMARY.md new file mode 100644 index 0000000..fc574b5 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/SUMMARY.md @@ -0,0 +1,32 @@ +# Table of contents + +* [Overview](README.md) +* [Changelog](release.md) +* [Deploy APIPark](deploy.md) +* [Services](services/README.md) + * [AI Services](services/ai_services.md) + * [REST Service](services/rest_services.md) + * [Review Consumers](services/review_consumers.md) +* [Consumers](consumers.md) +* [Team](teams.md) +* [API Developer Portal](developer_portal.md) +* [Calling the API](call_api.md) +* [API Call Analysis Report](analysis.md) +* [AI](ai/README.md) + * [AI API Management](ai/ai_api_manager.md) + * [APIKEY Resource Pool](ai/ai_mode_apikey.md) + * [ai\_model\_balance](ai/ai_model_balance.md) + * [Setting Up AI Models](ai/ai_model_providers.md) +* [System Settings](system_setting/README.md) + * [Account and Roles](system_setting/account_role.md) + * [API Gateway](system_setting/api_gateway_cluster.md) + * [Data Masking](system_setting/data_mask.md) + * [Data Source](system_setting/data_source.md) + * [General Settings](system_setting/regular_setting.md) + * [SSL Certificate](system_setting/ssl_cert.md) + * [Log Configuration](system_setting/log/README.md) + * [File Logging](system_setting/log/file-log.md) + * [HTTP Logs](system_setting/log/http-log.md) + * [Kafka Log](system_setting/log/kafka-log.md) + * [NSQ Logs](system_setting/log/nsq-log.md) + * [Syslog Logs](system_setting/log/syslog-log.md) diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md new file mode 100644 index 0000000..3a48836 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md @@ -0,0 +1,2 @@ +# AI + diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md index 646e421..81d65c4 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md @@ -1,17 +1,19 @@ --- sidebar_position: 7 -title: "🔎 API Developer Portal" +title: 🔎 API Developer Portal --- # API Developer Portal +## API Developer Portal + 👀 With the explosive growth of APIs within enterprises, IT management teams need a unified platform to display reusable internal APIs, allowing internal developers to quickly develop new products based on existing APIs. This also helps to avoid management costs and data leakage issues caused by arbitrary internal API usage. ✨ APIPark's **Developer Portal** is designed to showcase publicly available API services within a team, enabling developers to easily browse and find APIs that meet their needs, thus reducing the time spent searching and selecting APIs. Before using any API service, developers must subscribe to the service and wait for admin approval before they can officially call the API. This prevents unauthorized API calls and potential data breaches. APIPark automatically generates API usage statistics, displaying long-term call trends and performance changes to help companies maintain API stability. -## Create a Consumer +### Create a Consumer Before subscribing to API services, you need to create a **Consumer**. A consumer is the entity that **subscribes to services** and **calls APIs**. Consumers obtain the right to call APIs within a service by subscribing to it, ensuring data safety and compliance with access permissions. @@ -19,38 +21,36 @@ For creating a consumer, please refer to [🔗 Create a Consumer](consumers.md) ![](images/2024-10-28-23-05-08.png) -## Subscribe to API Services +### Subscribe to API Services In the **API Portal** module, you can see all publicly available API services. Click on the service you want to subscribe to, go to the detailed service introduction page, then click the **Subscribe** button, and select the **Consumer** for this subscription in the popup. > 💡 If the service you are subscribing to requires **manual review**, you may need to enter the purpose of your subscription to assist the service admin in the review process. You will need to wait for the subscription to be approved by the admin before you can call the service's API. Otherwise, APIPark will deny your API request and prompt a lack of API access rights. -> +> > 💡 If the service you are subscribing to does not require a review, you can call the service's API with consumer authentication immediately after subscribing. -> +> > [🔗 Learn More: Review Consumers](services/review_consumers.md) ![](images/2024-10-28-22-47-19.png) -## Call API +### Call API For calling the service's API, please refer to [🔗 Call API](call_api.md) - - -# **API** **Service Integration** +## **API** **Service Integration** APIPark supports seamless integration of API services into various AI Agent platforms. Developers can easily import these API services into their chosen AI Agent platform by simply copying and sharing the URL of the external API documentation, with no complex configuration or manual input required. This integration method not only improves work efficiency but also ensures the accuracy and consistency of the API services. Additionally, AI Agent platforms can fully leverage the rich API resources provided by APIPark to expand functionality and service coverage. -## **Obtain Integration URL or File** +### **Obtain Integration URL or File** Go to the **API Marketplace** module, select a specific API service, and enter the service details page. Then, choose the **Integration** tab. On this subpage, you can click the **Copy URL** button to obtain the integration URL. If the Agent platform you want to integrate with does not support URL-based integration, you can click **Download** **JSON** **File** to download the current API service’s JSON file, which is formatted in OpenAPI 3.0 standard. -![](images/2024-12-10/08e4b8ab9d6615609f670b8c79011ae205613d2c207e84fe06dbcb34a84766c7.png) +![](images/2024-12-10/08e4b8ab9d6615609f670b8c79011ae205613d2c207e84fe06dbcb34a84766c7.png) -## **Configure Integration Address Domain** +### **Configure Integration Address Domain** The system will by default use the current APIPark domain as the integration address domain. However, to comply with the company’s network security policies, you can configure a separate access domain for the integration address. Go to the **System Settings** module, select the **General** menu on the left, and then configure the **Integration Address**. Enter the domain name in the input field for the integration address. -![](images/2024-12-10/d2ef0e8c973d9a4ca0544398c9ed16e2dc55ebe8fb15f0761c879073cde7a719.png) \ No newline at end of file +![](images/2024-12-10/d2ef0e8c973d9a4ca0544398c9ed16e2dc55ebe8fb15f0761c879073cde7a719.png) diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/overview.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/overview.md deleted file mode 100644 index cd65689..0000000 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/overview.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -sidebar_position: 1 -title: "🦄 Overview" ---- - -# APIPark -![APIPark](images/Banner.png) - -**🦄APIPark is an open-source, all-in-one AI gateway and API developer portal designed to help developers and businesses easily manage, integrate, and deploy AI services. Based on the Apache 2.0 protocol, APIPark is open-source and can be used for commercial purposes for free!** - -✨With APIPark, you can achieve the following: -1. Quickly integrate over 100 AI models; we support all major AI companies! -2. Combine AI models and prompts into APIs, such as creating a sentiment analysis API, translation API, or data analysis API with OpenAI GPT4o and some custom prompts. -3. Standardize the request data format for all AI APIs, so switching AI models or modifying prompts won't affect your app or microservices, simplifying AI usage and maintenance. -4. Share APIs within your team through the APIPark developer portal. -5. Manage applications and API keys to ensure the security and stability of your APIs. -6. Monitor your AI API usage with clear charts. -7. Quickly output API request logs to third-party log platforms. - -![](images/2024-12-18/f9b31736882f149766c86bfe25f2a351c95f73606cfb80a3cb79ca7049d128cc.png) -
- -✨APIPark is also a powerful cloud-native API gateway: -1. It offers higher performance than Nginx and supports cluster deployment to handle large-scale traffic. -2. Share and manage REST APIs within your team to avoid management costs and data leakage issues due to chaotic API calls. - -
- -# 💌 Why did we create APIPark? -Before creating APIPark, we spent seven years developing an API development and automated testing platform, Eolink, with over 1 million developer users. We have over 500 corporate clients and received multi-million yuan investment from Sequoia Capital. - -With the development of AI and Agents, we found many enterprises wanted to integrate AI into internal systems and third-party APIs to enable AI Agents to perform more complex tasks, not just act as Q&A bots. Thus, we created APIPark, your one-stop AI gateway and API developer portal, to accelerate your AI API development and quickly build your products or AI Agents! - -
- -# ✨ Quick Start -APIPark aims to solve the following problems: -- Seamlessly integrate various large AI models and package these AI capabilities into APIs for easy calling, simplifying the threshold for using AI models. -- Manage complex AI & API call relationships. -- Manage API creation, monitoring, and security. -- Fault detection and troubleshooting: simplify system issue identification and resolution. -- Quantify data asset value: enhance data asset visibility and valuation. - -
- -😍 Deploying APIPark is straightforward; you can set up your AI gateway and API developer portal within 5 minutes with just one command line. - -``` -curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start.sh -``` - -
- -# 🔥 Features - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Quickly Integrate 100+ AI Models - - Call All AI Using a Unified API Format -
- - - -
- One-Click Prompt to REST API Conversion - - Quickly Share APIs Within Teams -
- - - -
- Performance Rivaling Nginx - - Complete API Design, Release, Call, Decommissioning in One Place -
- - - -
- Approve API Call Requests from Tenants - - Multi-Tenant Management -
- - - -
- Detailed Logging of All API Calls - - Powerful Data Analysis -
- - - -
- -
- -# 🚀 Use Cases -## Simplify AI Integration Cost - - Connect to over 100 major models from mainstream AI vendors with a unified API call, without extra adaptation work. - - Create new AI APIs by combining AI models and prompts, simplifying AI API development. - - Quickly share AI APIs within the team. - -## Improve Operational Efficiency - - Rapidly build an internal API developer portal. - - Efficiently manage and call APIs. - - Reduce complex inter-system call relationships. - -## Ensure Compliance and Security - - Strong service governance and compliance management features. - - Granular management of application call permissions. - - Ensure the security and compliance of API calls, reducing enterprise risk. - -## Simplify System Troubleshooting - - Quickly detect and resolve issues using monitoring and fault diagnosis tools. - - Reduce downtime and improve system stability. - -## Multi-Tenant Management and Flexible Subscription - - Supports multi-tenant management, catering to different business unit needs. - - Flexible subscription and approval processes simplify API usage and management. - -## Enhance API Observability - - Real-time monitoring and tracking of API usage. - - Comprehensive understanding of data flow, enhancing data usage transparency. - -
- -# 🚩 Roadmap -We have exciting goals for APIPark: enabling everyone to quickly create their products and AI Agents with AI and APIs! - -To achieve this, we plan to add new features to APIPark: -1. Integrate API markets like Postman, RapidAPI, APISpace, APILayer, etc. You can use APIs from various markets directly through APIPark and make them smarter with AI. -2. Integrate AI Agents like Langchain, AgentGPT, Auto-GPT, Dify, etc., allowing AI Agents to access your internal systems or third-party APIs via APIPark for more complex tasks. -3. Intelligent API Orchestration, offering a unified API entry through APIPark to automatically orchestrate multiple APIs based on your request content to meet your needs. - -
- -# 📕 Documentation -Visit [APIPark Documentation](https://docs.apipark.com/docs/install) for detailed installation guides, API references, and usage instructions. - -
- -# 🧾 License -APIPark uses the Apache 2.0 license. For more details, please check the LICENSE file. - -
- -# 💌 Contact Us -For enterprise-level features and professional technical support, please contact our pre-sales experts for personalized demonstrations, customized solutions, and quotes. - -- Website: https://apipark.com -- Email: contact@apipark.com - -
- -🙏 Thank you to everyone who helped shape APIPark. We are excited to hear from the community! Let's make the world of APIs and AI stronger and more exciting together. 🎉 \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md new file mode 100644 index 0000000..55f5101 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md @@ -0,0 +1,2 @@ +# Services + diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md new file mode 100644 index 0000000..0595267 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md @@ -0,0 +1,2 @@ +# System Settings + From 86b61f1e8bb65277609fbc0ac6907f85647e9c47 Mon Sep 17 00:00:00 2001 From: Addison Schultz Date: Mon, 10 Feb 2025 07:13:46 +0000 Subject: [PATCH 2/4] GITBOOK-1: Update structure --- docs/README.md | 159 +++++++++++++++++++++++++ docs/SUMMARY.md | 32 +++++ docs/ai/README.md | 2 + docs/developer_portal.md | 27 ++--- docs/overview.md | 217 ---------------------------------- docs/services/README.md | 2 + docs/system_setting/README.md | 2 + 7 files changed, 210 insertions(+), 231 deletions(-) create mode 100644 docs/README.md create mode 100644 docs/SUMMARY.md create mode 100644 docs/ai/README.md delete mode 100644 docs/overview.md create mode 100644 docs/services/README.md create mode 100644 docs/system_setting/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..b0f7458 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,159 @@ +--- +sidebar_position: 1 +title: 🦄 概述 +--- + +# 概述 + +## APIPark + +![APIPark](images/Banner.png) + +**🦄APIPark 是开源的一站式AI网关和API开发者门户，帮助开发者和企业轻松管理、集成和部署AI服务。APIPark 基于 Apache 2.0 协议开源，这意味着它可以免费商用！** + +✨你可以通过APIPark实现以下需求： + +1. 快速接入 100+ AI 模型，我们支持所有主流的AI公司！ +2. 将 AI 模型和 Prompt 提示词组合成API，比如基于 OpenAI GPT4o和一些自定义的提示词，创建一个情感分析API，翻译API或数据分析API。 +3. 统一所有 AI API 的请求数据格式，当你切换 AI 模型，或者修改 Prompt 提示词的时候不会影响你的 APP 应用或者微服务，简化你的 AI 使用和维护成本。 +4. 通过 APIPark 的开发者门户，将 API 在团队内共享。 +5. 管理调用的应用、API Key，保障你的 API 安全和稳定性。 +6. 通过清晰的图表来监控你的 AI API 使用情况。 +7. 将API请求日志快速输出到第三方日志平台。 + +![\
1](images/2024-10-26/2f3a9b53d1b32c3f26339d8bbb58640db92f6e670e530ee673fad168537423ca.png)\ +\ + + +✨APIPark 还是一个强大的云原生 API 网关： + +1. 拥有比 Nginx 更高的性能，并且支持集群部署，能够支持大规模的流量。 +2. 将 REST API 在团队内共享，并管理API的调用关系，避免因混乱的API调用导致的管理成本和数据泄露问题。 + +\ + + +## 💌 我们为什么打造 APIPark？ + +在打造 APIPark之前，我们已经花费了7年时间打造了一个拥有超过100万开发者用户的API开发和自动化测试平台 Eolink，拥有超过500家企业客户并且获得了红杉资本的数千万元投资。 + +随着AI和Agent的发展，我们发现许多企业希望将AI接入企业内部系统的API以及第三方的API，让AI Agent能够完成更复杂的任务，而不仅是作为知识问答机器人。因此我们打造了 APIPark，你的一站式 AI 网关和 API开发者门户，加速你的 AI API 开发，并快速打造你的产品或 AI Agent！ + +\ + + +## ✨ 快速开始 + +APIPark 致力于解决以下问题： + +* 无缝接入多种大型AI模型，并将这些AI能力打包成API进行调用，从而大幅简化了AI模型的使用门槛。 +* 管理复杂的 AI & API 调用关系。 +* 管理 API 的创建、监控、安全。 +* 故障检测和排查：简化系统问题的识别和解决。 +* 量化数据资产价值：提升数据资产的可见性和估值。 + +\ + + +😍 APIPark 部署非常简单，仅需一句命令行即可在 5 分钟内部署好你的 AI 网关和 API 开发者门户。 + +``` +curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start.sh +``` + +\ + + +## 🔥 特性 + +| 快速接入 100+ AI 模型 | 通过统一的 API 格式来调用所有 AI | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| ![](https://apipark.com/wp-content/uploads/2024/10/AI-Gateway.png) | ![](https://apipark.com/wp-content/uploads/2024/10/Unified-API.png) | +| 一键将 Prompt 提示词封装成 REST API | 在团队内快速共享 API 服务 | +| ![](https://apipark.com/wp-content/uploads/2024/10/Prompt-template.png) | ![](https://apipark.com/wp-content/uploads/2024/10/developer-portal.png) | +| 比肩 Nginx 的强大性能 | 一站式完成 API 设计、发布、调用、下线 | +| ![](https://apipark.com/wp-content/uploads/2024/10/hyper-performance.png) | ![](https://apipark.com/wp-content/uploads/2024/08/Life-Cycle.png) | +| 审核租户的API的调用申请 | 多租户管理 | +| ![](https://apipark.com/wp-content/uploads/2024/08/Application.png) | ![](https://apipark.com/wp-content/uploads/2024/08/Multi-tenant.png) | +| 详细记录所有 API 的调用日志 | 强大的数据分析 | +| ![](https://apipark.com/wp-content/uploads/2024/08/Chart-1.png) | ![](https://apipark.com/wp-content/uploads/2024/08/Chart.png) | + +\ + + +## 🚀 适用场景 + +### 简化 AI 的接入成本 + +* 接入所有主流AI供应商的 100+ 大模型，并且通过统一的 API 调用，没有额外的适配工作。 +* 通过组合 AI 模型和 Prompt 提示词，形成新的 AI API，简化 AI API 的开发工作。 +* 将 AI API 在团队内部快速共享。 + +### 提升运营效率 + +* 快速构建团队内的 API 开发者门户。 +* 高效管理和调用 API。 +* 减少复杂的系统间调用关系。 + +### 确保合规与安全 + +* 强大的服务治理和合规管理功能。 +* 精细化管理应用调用的权限。 +* 确保 API 调用的安全性和合规性，降低企业风险。 + +### 简化系统故障排查 + +* 利用监控和故障诊断工具快速发现和解决问题。 +* 减少停机时间，提高系统稳定性。 + +### 多租户管理和灵活订阅 + +* 支持多租户管理，满足不同业务单元需求。 +* 灵活的订阅和审核流程简化 API 的使用和管理。 + +### 增强 API 可观测性 + +* 实时监控和追踪 API 使用情况。 +* 全面掌握数据流动，提升数据使用透明度。 + +\ + + +## 🚩 路线图 + +我们为 APIPark 制定了激动人心的目标：让每个人都能通过 AI 和 API 快速创建自己的产品和AI Agent！ + +为了实现这个目标，我们接下来会为APIPark增加新的特性： + +1. 接入 API 市场，比如 Postman、RapidAPI、APISpace、APILayer 等。你可以直接通过APIPark使用来自各个 API 市场的 API，并通过 AI 让这些 API 更智能。 +2. 接入 AI Agent，比如Langchain、AgentGPT、Auto-GPT、Dify等。让 AI Agent 通过 APIPark 接入你的内部系统或第三方API，完成更复杂的工作。 +3. 智能 API 编排，APIPark 会提供一个统一的API入口，自动判断 API 请求的内容来编排多个 API 来完成你的需求。 + +\ + + +## 📕文档 + +访问 [APIPark文档](https://docs.apipark.com/docs/install) 获取详细的安装指南、API 参考和使用说明。 + +\ + + +## 🧾许可证 + +APIPark 使用 Apache 2.0 许可证。更多详情请查看 LICENSE 文件。 + +\ + + +## 💌联系我们 + +对于企业级功能和专业技术支持，请联系售前专家进行个性化演示、定制方案和获取报价。 + +* 网站: https://apipark.com +* 电子邮件: contact@apipark.com + +\ + + +🙏 非常感谢所有帮助塑造 APIPark 的人，我们非常高兴听到社区的想法！让我们一起让API和AI的世界变得更强大和有趣。🎉 diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..91171e9 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,32 @@ +# Table of contents + +* [概述](README.md) +* [更新日志](release.md) +* [部署 APIPark](deploy.md) +* [服务](services/README.md) + * [AI 服务](services/ai_services.md) + * [REST 服务](services/rest_services.md) + * [审核消费者](services/review_consumers.md) +* [消费者](consumers.md) +* [团队](teams.md) +* [API 开发者门户](developer_portal.md) +* [调用API](call_api.md) +* [API 调用分析报告](analysis.md) +* [AI](ai/README.md) + * [AI API 管理](ai/ai_api_manager.md) + * [APIKEY 资源池](ai/ai_mode_apikey.md) + * [AI 模型负载均衡](ai/ai_model_balance.md) + * [设置 AI 模型](ai/ai_model_providers.md) +* [系统设置](system_setting/README.md) + * [账号与角色](system_setting/account_role.md) + * [API 网关](system_setting/api_gateway_cluster.md) + * [数据脱敏](system_setting/data_mask.md) + * [数据源](system_setting/data_source.md) + * [常规设置](system_setting/regular_setting.md) + * [SSL证书](system_setting/ssl_cert.md) + * [日志配置](system_setting/log/README.md) + * [文件日志](system_setting/log/file-log.md) + * [HTTP日志](system_setting/log/http-log.md) + * [Kafka日志](system_setting/log/kafka-log.md) + * [NSQ日志](system_setting/log/nsq-log.md) + * [Syslog日志](system_setting/log/syslog-log.md) diff --git a/docs/ai/README.md b/docs/ai/README.md new file mode 100644 index 0000000..3a48836 --- /dev/null +++ b/docs/ai/README.md @@ -0,0 +1,2 @@ +# AI + diff --git a/docs/developer_portal.md b/docs/developer_portal.md index 40b91d8..e796303 100644 --- a/docs/developer_portal.md +++ b/docs/developer_portal.md @@ -1,18 +1,19 @@ --- sidebar_position: 7 -title: "🔎 API 开发者门户" +title: 🔎 API 开发者门户 --- # API 开发者门户 +## API 开发者门户 + 👀 随着企业内部的 API 数量爆发式增长，企业的 IT 管理团队需要一个统一的平台展示内部可复用的 API，让内部开发人员能够基于现成的 API 快速开发新的产品，同时避免因内部 API 随意调用导致的管理成本和数据泄露问题。 ✨ APIPark 的 **开发者门户** 用于统一展示团队内公开的 API 服务，让开发者能够方便地浏览和查找适合自己需求的 API，减少寻找和选择 API 的时间。同时，开发者在使用 API 服务前需要先订阅服务，并等待管理员审核通过后才能正式调用API，避免违规调用 API 导致的数据泄露等安全问题。 APIPark 会自动生成 API 的调用统计，展示 API 长期的调用趋势和性能变化，帮助企业维护 API 的稳定性。 - -## 创建消费者 +### 创建消费者 订阅 API 服务之前，你需要先创建一个**消费者（Consumer）**，消费者是 **订阅服务** 和 **调用API** 的实体，消费者通过订阅服务来获得调用服务内API的权限，确保数据安全和访问权限合规。 @@ -20,39 +21,37 @@ APIPark 会自动生成 API 的调用统计，展示 API 长期的调用趋势 ![](images/2024-10-28-23-05-08.png) - -## 订阅 API 服务 +### 订阅 API 服务 进入 **API 门户** 模块，你可以看到所有已经公开的 API 服务。点击需要订阅的服务，进入服务详细介绍页面，然后点击 **订阅** 按钮，在弹窗中选择订阅该服务的 **消费者**。 > 💡 如果你订阅的服务开启了 **人工审核**，那你订阅服务时可能需要输入订阅服务的用途，便于服务的管理员审核。并且你需要等服务的管理员对你的订阅申请审核通过之后，才能调用服务的API，否则 APIPark 会拒绝你的 API 请求并提示缺少 API 的访问权限。 -> +> > 💡 如果你订阅的服务是无需审核的，那你订阅之后就可以通过消费者的身份认证来调用该服务的 API。 -> +> > [🔗 了解更多：审核消费者](services/review_consumers.md) ![](images/2024-10-28-22-47-19.png) - -## 调用 API +### 调用 API 如果需要调用服务的 API，请查看 [🔗 调用 API](call_api.md) -# API 服务集成 +## API 服务集成 **APIPark** 支持**将** **API** **服务无缝集成到各种** **AI** **Agent 平台中**。一键复制分享 API 服务的对外可读取文档详细信息的 URL，开发者则可轻松地将这些 API 服务导入到他们选择的 **AI Agent** 平台，无需复杂配置或手动输入。 这种集成方式不仅提高了工作效率，还确保了 API 服务的准确性和一致性；同时 **AI** **Agent** 平台还可以充分利用 **APIPark** 提供的丰富 API 资源，扩展功能和服务范围。 -## 获取集成地址或文件 +### 获取集成地址或文件 进入 **API市场** 模块，选中某个API服务并进入服务详情页，然后选择 **集成Tab**。 在该子页面即可一键点击【复制URL】按钮获取到集成地址，如果需要集成的Agent平台不支持读取URL集成，那么可以点击【下载 Json 文件】，可下载当前API服务的Json文件，该文件格式为Openapi 3.0 标准格式。 -![](images/2024-12-10/08e4b8ab9d6615609f670b8c79011ae205613d2c207e84fe06dbcb34a84766c7.png) +![](images/2024-12-10/08e4b8ab9d6615609f670b8c79011ae205613d2c207e84fe06dbcb34a84766c7.png) -## 配置集成地址域名 +### 配置集成地址域名 系统会默认使用当前APIPark的域名为集成地址域名，但是为了适用企业的网络安全策略，我们可以单独为集成地址配置单独的访问域名。 @@ -60,4 +59,4 @@ APIPark 会自动生成 API 的调用统计，展示 API 长期的调用趋势 在集成地址的输入框内输入域名即可。 -![](images/2024-12-10/d2ef0e8c973d9a4ca0544398c9ed16e2dc55ebe8fb15f0761c879073cde7a719.png) \ No newline at end of file +![](images/2024-12-10/d2ef0e8c973d9a4ca0544398c9ed16e2dc55ebe8fb15f0761c879073cde7a719.png) diff --git a/docs/overview.md b/docs/overview.md deleted file mode 100644 index 0ecaea4..0000000 --- a/docs/overview.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -sidebar_position: 1 -title: "🦄 概述" ---- - -# APIPark -![APIPark](images/Banner.png) - -**🦄APIPark 是开源的一站式AI网关和API开发者门户，帮助开发者和企业轻松管理、集成和部署AI服务。APIPark 基于 Apache 2.0 协议开源，这意味着它可以免费商用！** - -✨你可以通过APIPark实现以下需求： -1. 快速接入 100+ AI 模型，我们支持所有主流的AI公司！ -2. 将 AI 模型和 Prompt 提示词组合成API，比如基于 OpenAI GPT4o和一些自定义的提示词，创建一个情感分析API，翻译API或数据分析API。 -3. 统一所有 AI API 的请求数据格式，当你切换 AI 模型，或者修改 Prompt 提示词的时候不会影响你的 APP 应用或者微服务，简化你的 AI 使用和维护成本。 -4. 通过 APIPark 的开发者门户，将 API 在团队内共享。 -5. 管理调用的应用、API Key，保障你的 API 安全和稳定性。 -6. 通过清晰的图表来监控你的 AI API 使用情况。 -7. 将API请求日志快速输出到第三方日志平台。 - -![
1](images/2024-10-26/2f3a9b53d1b32c3f26339d8bbb58640db92f6e670e530ee673fad168537423ca.png) -
- -✨APIPark 还是一个强大的云原生 API 网关： -1. 拥有比 Nginx 更高的性能，并且支持集群部署，能够支持大规模的流量。 -2. 将 REST API 在团队内共享，并管理API的调用关系，避免因混乱的API调用导致的管理成本和数据泄露问题。 - -
- -# 💌 我们为什么打造 APIPark？ -在打造 APIPark之前，我们已经花费了7年时间打造了一个拥有超过100万开发者用户的API开发和自动化测试平台 Eolink，拥有超过500家企业客户并且获得了红杉资本的数千万元投资。 - -随着AI和Agent的发展，我们发现许多企业希望将AI接入企业内部系统的API以及第三方的API，让AI Agent能够完成更复杂的任务，而不仅是作为知识问答机器人。因此我们打造了 APIPark，你的一站式 AI 网关和 API开发者门户，加速你的 AI API 开发，并快速打造你的产品或 AI Agent！ - -
- - -# ✨ 快速开始 -APIPark 致力于解决以下问题： -- 无缝接入多种大型AI模型，并将这些AI能力打包成API进行调用，从而大幅简化了AI模型的使用门槛。 -- 管理复杂的 AI & API 调用关系。 -- 管理 API 的创建、监控、安全。 -- 故障检测和排查：简化系统问题的识别和解决。 -- 量化数据资产价值：提升数据资产的可见性和估值。 - - -
- -😍 APIPark 部署非常简单，仅需一句命令行即可在 5 分钟内部署好你的 AI 网关和 API 开发者门户。 - -``` -curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start.sh -``` - -
- -# 🔥 特性 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 快速接入 100+ AI 模型 - - 通过统一的 API 格式来调用所有 AI -
- - - -
- 一键将 Prompt 提示词封装成 REST API - - 在团队内快速共享 API 服务 -
- - - -
- 比肩 Nginx 的强大性能 - - 一站式完成 API 设计、发布、调用、下线 -
- - - -
- 审核租户的API的调用申请 - - 多租户管理 -
- - - -
- 详细记录所有 API 的调用日志 - - 强大的数据分析 -
- - - -
- - -
- -# 🚀 适用场景 -## 简化 AI 的接入成本 - - 接入所有主流AI供应商的 100+ 大模型，并且通过统一的 API 调用，没有额外的适配工作。 - - 通过组合 AI 模型和 Prompt 提示词，形成新的 AI API，简化 AI API 的开发工作。 - - 将 AI API 在团队内部快速共享。 - -## 提升运营效率 - - 快速构建团队内的 API 开发者门户。 - - 高效管理和调用 API。 - - 减少复杂的系统间调用关系。 - -## 确保合规与安全 - - 强大的服务治理和合规管理功能。 - - 精细化管理应用调用的权限。 - - 确保 API 调用的安全性和合规性，降低企业风险。 - -## 简化系统故障排查 - - 利用监控和故障诊断工具快速发现和解决问题。 - - 减少停机时间，提高系统稳定性。 - -## 多租户管理和灵活订阅 - - 支持多租户管理，满足不同业务单元需求。 - - 灵活的订阅和审核流程简化 API 的使用和管理。 - -## 增强 API 可观测性 - - 实时监控和追踪 API 使用情况。 - - 全面掌握数据流动，提升数据使用透明度。 - -
- - -# 🚩 路线图 -我们为 APIPark 制定了激动人心的目标：让每个人都能通过 AI 和 API 快速创建自己的产品和AI Agent！ - -为了实现这个目标，我们接下来会为APIPark增加新的特性： -1. 接入 API 市场，比如 Postman、RapidAPI、APISpace、APILayer 等。你可以直接通过APIPark使用来自各个 API 市场的 API，并通过 AI 让这些 API 更智能。 -2. 接入 AI Agent，比如Langchain、AgentGPT、Auto-GPT、Dify等。让 AI Agent 通过 APIPark 接入你的内部系统或第三方API，完成更复杂的工作。 -3. 智能 API 编排，APIPark 会提供一个统一的API入口，自动判断 API 请求的内容来编排多个 API 来完成你的需求。 - - -
- -# 📕文档 -访问 [APIPark文档](https://docs.apipark.com/docs/install) 获取详细的安装指南、API 参考和使用说明。 - -
- -# 🧾许可证 -APIPark 使用 Apache 2.0 许可证。更多详情请查看 LICENSE 文件。 - - -
- -# 💌联系我们 -对于企业级功能和专业技术支持，请联系售前专家进行个性化演示、定制方案和获取报价。 - -- 网站: https://apipark.com -- 电子邮件: contact@apipark.com - -
- -🙏 非常感谢所有帮助塑造 APIPark 的人，我们非常高兴听到社区的想法！让我们一起让API和AI的世界变得更强大和有趣。🎉 diff --git a/docs/services/README.md b/docs/services/README.md new file mode 100644 index 0000000..a41238f --- /dev/null +++ b/docs/services/README.md @@ -0,0 +1,2 @@ +# 服务 + diff --git a/docs/system_setting/README.md b/docs/system_setting/README.md new file mode 100644 index 0000000..72cdf52 --- /dev/null +++ b/docs/system_setting/README.md @@ -0,0 +1,2 @@ +# 系统设置 + From ebe90d8ff5aae0b7d0c98848420294bff1ba6806 Mon Sep 17 00:00:00 2001 From: Addison Schultz Date: Mon, 10 Feb 2025 07:33:20 +0000 Subject: [PATCH 3/4] GITBOOK-2: No subject --- .../version-1.4-beta/README.md | 1 + .../version-1.4-beta/ai/README.md | 4 + .../version-1.4-beta/analysis.md | 8 +- .../version-1.4-beta/call_api.md | 28 ++-- .../version-1.4-beta/consumers.md | 25 ++-- .../version-1.4-beta/deploy.md | 122 ++++++++---------- .../version-1.4-beta/developer_portal.md | 1 + .../version-1.4-beta/release.md | 30 +++-- .../version-1.4-beta/services/README.md | 4 + .../version-1.4-beta/system_setting/README.md | 4 + .../version-1.4-beta/teams.md | 18 ++- 11 files changed, 128 insertions(+), 117 deletions(-) diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md index 488aa6e..077092a 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/README.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: 🦄 Overview +icon: alicorn --- # Overview diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md index 3a48836..0ce6e55 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/ai/README.md @@ -1,2 +1,6 @@ +--- +icon: sparkles +--- + # AI diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/analysis.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/analysis.md index de41ac2..f7ca8ef 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/analysis.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/analysis.md @@ -1,13 +1,13 @@ --- sidebar_position: 9 -title: "📊 Analysis Report" +title: 📊 Analysis Report +icon: file-chart-column --- # API Call Analysis Report APIPark provides insights into long-term API call trends and performance changes by analyzing historical call data, helping businesses maintain API stability. -> 💡 APIPark's API Call Analysis Report relies on the InfluxDB database. If you deploy using the script provided by APIPark, InfluxDB will be installed by default. Learn more: [🔗 Deploy APIPark](deploy.md). -> 💡 You can also deploy an external InfluxDB database and then fill in the InfluxDB data source information in the system settings of APIPark. Learn more: [🔗 Set Data Source](system_setting/data_source.md). +> 💡 APIPark's API Call Analysis Report relies on the InfluxDB database. If you deploy using the script provided by APIPark, InfluxDB will be installed by default. Learn more: [🔗 Deploy APIPark](deploy.md). 💡 You can also deploy an external InfluxDB database and then fill in the InfluxDB data source information in the system settings of APIPark. Learn more: [🔗 Set Data Source](system_setting/data_source.md). -![](images/2024-10-28/bd920673b71b05514a44eab4e18a64f50aea2ab69f629687aea46b346bcbf51c.png) \ No newline at end of file +![](images/2024-10-28/bd920673b71b05514a44eab4e18a64f50aea2ab69f629687aea46b346bcbf51c.png) diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/call_api.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/call_api.md index abbad44..8a3da5f 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/call_api.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/call_api.md @@ -1,6 +1,7 @@ --- sidebar_position: 8 -title: "🔗 Calling the API" +title: 🔗 Calling the API +icon: cloud-bolt --- # Calling the API @@ -9,35 +10,30 @@ title: "🔗 Calling the API" Before making a call, the following conditions must be met: -- The **consumer** has created an **authorization certificate**. Learn more: [🔗 Consumers](consumers.md). -- The **consumer** has successfully subscribed to the service. Learn more: [🔗 API Portal](developer_portal.md). - +* The **consumer** has created an **authorization certificate**. Learn more: [🔗 Consumers](consumers.md). +* The **consumer** has successfully subscribed to the service. Learn more: [🔗 API Portal](developer_portal.md). ## Example 😜 Suppose: -- The **consumer**'s **authorization certificate** is as follows: - - **Authentication Type**: API Key - - **Parameter Location**: Header - - **Parameter Name**: Authorization - - **Key**: 96f55...ee4 -- The API endpoint for the **service** is: **http://api.apipark.com/cda53bf2/demo_translation_api** - -![](images/2024-10-28/5fbe42033e3fb02015f4ef886efd6b9d09ed560252a1fd2a35a94df3ebec5e16.png) +* The **consumer**'s **authorization certificate** is as follows: + * **Authentication Type**: API Key + * **Parameter Location**: Header + * **Parameter Name**: Authorization + * **Key**: 96f55...ee4 +* The API endpoint for the **service** is: **http://api.apipark.com/cda53bf2/demo\_translation\_api** +![](images/2024-10-28/5fbe42033e3fb02015f4ef886efd6b9d09ed560252a1fd2a35a94df3ebec5e16.png) You can use any of the following methods to call the service API. - - ### Postman or Other API Clients In the API testing tool, add the Authorization parameter in the Header and set the parameter value to 96f55...ee4: ![](images/2024-10-29-01-47-24.png) - ### cURL Enter in the command line: @@ -46,4 +42,4 @@ Enter in the command line: curl -X POST -H "Authorization: 96f55...ee4" \ -H "Content-Type: application/json" -d "request body content" \ http://api.apipark.com/cda53bf2/demo_translation_api -``` \ No newline at end of file +``` diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/consumers.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/consumers.md index 8683f9f..b8f92c7 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/consumers.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/consumers.md @@ -1,9 +1,11 @@ --- sidebar_position: 5 -title: "⌨️ Consumers" +title: ⌨️ Consumers +icon: keyboard --- # Consumers + APIPark provides an **API portal** feature that allows users to publish services to the API portal, where they can be viewed, subscribed to, and invoked by other users. In APIPark, a **Consumer** is an entity that **subscribes to services** and **calls APIs**. Consumers subscribe to services to gain the permissions needed to call the APIs within those services, ensuring data security and compliance with access permissions. @@ -12,16 +14,15 @@ To ensure secure and standardized use of APIs and to reduce management costs, us ![](images/2024-10-28-23-05-08.png) - ## Creating a Consumer Before subscribing to API services, you need to create a **Consumer**. A consumer is an entity that subscribes to services and calls APIs. Consumers obtain the permission to call the APIs within a service by subscribing to it, ensuring data security and compliance. Go to the **Workspace** module, select **Consumers** from the sidebar, and then **Create Consumer**. Fill in the following: -- **Consumer Name** -- **Consumer ID**: A unique identifier for the consumer that cannot be changed once saved. -- **Description** +* **Consumer Name** +* **Consumer ID**: A unique identifier for the consumer that cannot be changed once saved. +* **Description** ![](images/2024-10-28-23-09-51.png) @@ -31,12 +32,12 @@ APIPark uses **Credentials** to restrict **Consumers**' access to API resources, Enter the management interface of **Consumers**, select **Credentials** from the sidebar, and click **Create Credential**. Fill in the following in the popup window: -- **Credential Name**: For easy management of the key, it's recommended to give it a clear and understandable name. -- **Authentication Type**: The method of authentication for the credential, including Basic Auth, API Key, JWT, AK/SK, etc. Each authentication method has different parameter fields and key rules. -- **Parameter Position**: The location where the key is filled in. -- **Key**: When requesting an API from APIPark, include the key in request parameters. To avoid data breaches, do not store keys in publicly accessible code. -- **Expiration Time**: Credentials are created with no expiration by default. If you want to create a temporary credential, such as one valid for only three months, you can specify an expiration date. If a request is made using an expired credential, APIPark will return a credential expiration error. -- **Hide Authentication Information**: By default, APIPark's API Gateway forwards the consumer's credentials to the upstream service, allowing it to perform secondary authorization verification. If this option is checked, APIPark will hide authentication information when forwarding requests. +* **Credential Name**: For easy management of the key, it's recommended to give it a clear and understandable name. +* **Authentication Type**: The method of authentication for the credential, including Basic Auth, API Key, JWT, AK/SK, etc. Each authentication method has different parameter fields and key rules. +* **Parameter Position**: The location where the key is filled in. +* **Key**: When requesting an API from APIPark, include the key in request parameters. To avoid data breaches, do not store keys in publicly accessible code. +* **Expiration Time**: Credentials are created with no expiration by default. If you want to create a temporary credential, such as one valid for only three months, you can specify an expiration date. If a request is made using an expired credential, APIPark will return a credential expiration error. +* **Hide Authentication Information**: By default, APIPark's API Gateway forwards the consumer's credentials to the upstream service, allowing it to perform secondary authorization verification. If this option is checked, APIPark will hide authentication information when forwarding requests. ![](images/2024-10-28-23-15-15.png) @@ -46,4 +47,4 @@ To subscribe to services using a Consumer, please refer to [🔗 Subscribe to AP ## Calling APIs with a Consumer -To call a service's APIs, please refer to [🔗 Call API](call_api.md). \ No newline at end of file +To call a service's APIs, please refer to [🔗 Call API](call_api.md). diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/deploy.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/deploy.md index 4bbf719..535f20a 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/deploy.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/deploy.md @@ -1,30 +1,28 @@ --- sidebar_position: 3 title: 🚀 Deploy APIPark +icon: rocket-launch --- # Deploy APIPark + ## Hardware Requirements -:::tip -Recommended Configuration: +:::tip Recommended Configuration: -- **CPU**: 8 cores -- **Memory**: 16GB -- **Disk Storage**: 200GB -- **Operating System**: Linux / Mac -- **System Architecture**: AMD64 / ARM64 - ::: +* **CPU**: 8 cores +* **Memory**: 16GB +* **Disk Storage**: 200GB +* **Operating System**: Linux / Mac +* **System Architecture**: AMD64 / ARM64 ::: -:::note -Minimum Configuration: +:::note Minimum Configuration: -- **CPU**: 2 cores -- **Memory**: 4GB -- **Disk Storage**: 200GB -- **Operating System**: Linux / Mac -- **System Architecture**: AMD64 / ARM64 - ::: +* **CPU**: 2 cores +* **Memory**: 4GB +* **Disk Storage**: 200GB +* **Operating System**: Linux / Mac +* **System Architecture**: AMD64 / ARM64 ::: ## Program Dependencies @@ -36,8 +34,7 @@ Minimum Configuration: ### Deploy using Script -:::note -Supported System List: +:::note Supported System List: * CentOS 7.9 (representing 7.x) * CentOS 8.5 (representing 8.x) @@ -47,8 +44,7 @@ Supported System List: * Alibaba Cloud Linux 3.2104 * Alibaba Cloud Linux 2.1903 -Currently, the installations have only been tested for the above systems. If you need a one-click deployment for other systems, you can submit an [Issue](https://github.com/APIParkLab/APIPark/issues) to us. -::: +Currently, the installations have only been tested for the above systems. If you need a one-click deployment for other systems, you can submit an [Issue](https://github.com/APIParkLab/APIPark/issues) to us. ::: Enter the one-click deployment command: @@ -64,7 +60,7 @@ Follow the prompts to deploy. After deployment is complete, deployment informati To install APIPark using this method, you need to install [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/). -After the deployment, APIPark needs to bind with the API Gateway node to function. For detailed instructions, please refer to [Configure API Gateway](./system_setting/api_gateway_cluster.md). +After the deployment, APIPark needs to bind with the API Gateway node to function. For detailed instructions, please refer to [Configure API Gateway](system_setting/api_gateway_cluster.md). ::: @@ -140,20 +136,20 @@ peer: # Configuration information for communication between cluster nodes **Configuration Description** -| Field Name | Description | -| :------------------------ | :----------------------------------------------------------- | -| version | Configuration version number, default is 2 | -| client | openAPI configuration information | -| client -> listen_urls | List of openAPI listening addresses, format: `{protocol}://{IP}:{port}` | -| client -> advertise_urls | List of openAPI broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | -| client -> certificate | List of openAPI certificate information | -| gateway | Configuration information for forwarding proxy core program | -| gateway -> listen_urls | List of forwarding proxy core program listening addresses, format: `{protocol}://{IP}:{port}` | -| gateway -> advertise_urls | List of forwarding proxy core program broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | -| peer | Configuration information for Raft nodes, used for configuration synchronization, joining the cluster, leaving the cluster, etc. | -| peer -> listen_urls | List of Raft node listening addresses, format: `{protocol}://{IP}:{port}` | -| peer -> advertise_urls | List of Raft node broadcast addresses, format: `{protocol}://{IP/domain}:{port}` | -| peer -> certificate | List of Raft node certificate information | +| Field Name | Description | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| version | Configuration version number, default is 2 | +| client | openAPI configuration information | +| client -> listen\_urls | List of openAPI listening addresses, format: `{protocol}://{IP}:{port}` | +| client -> advertise\_urls | List of openAPI broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | +| client -> certificate | List of openAPI certificate information | +| gateway | Configuration information for forwarding proxy core program | +| gateway -> listen\_urls | List of forwarding proxy core program listening addresses, format: `{protocol}://{IP}:{port}` | +| gateway -> advertise\_urls | List of forwarding proxy core program broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | +| peer | Configuration information for Raft nodes, used for configuration synchronization, joining the cluster, leaving the cluster, etc. | +| peer -> listen\_urls | List of Raft node listening addresses, format: `{protocol}://{IP}:{port}` | +| peer -> advertise\_urls | List of Raft node broadcast addresses, format: `{protocol}://{IP/domain}:{port}` | +| peer -> certificate | List of Raft node certificate information | 3. Edit `docker-compose.yml` file @@ -384,9 +380,9 @@ networks: In the above configuration, values within "{}" are variables. Descriptions of relevant variables are as follows: -- **MYSQL_PWD:** Initialization password for the MySQL database root user. -- **REDIS_PWD:** Redis password. -- **ADMIN_PASSWORD:** Initial password for APIPark Admin account. +* **MYSQL\_PWD:** Initialization password for the MySQL database root user. +* **REDIS\_PWD:** Redis password. +* **ADMIN\_PASSWORD:** Initial password for APIPark Admin account. Example of replaced configuration: @@ -619,7 +615,6 @@ After execution, the following images will be displayed: ![](images/2024-10-30/0d4ef04a942f1a6e47c6b43ddeda1d0c5e7f8a4ff4b6c7ffde08c4594481bee4.png) - ![](images/2024-10-30/bcd15ba41f68be367f87ff38709f1fb60f3de5e8c24b4b658b2e4bd8afd7dcdb.png) #### Independently Deploy APIPark @@ -836,9 +831,9 @@ networks: In the above configuration, values within "{}" are variables. Descriptions of relevant variables are as follows: -- **MYSQL_PWD:** Initialization password for the MySQL database root user. -- **REDIS_PWD:** Redis password. -- **ADMIN_PASSWORD:** Initial password for APIPark Admin account. +* **MYSQL\_PWD:** Initialization password for the MySQL database root user. +* **REDIS\_PWD:** Redis password. +* **ADMIN\_PASSWORD:** Initial password for APIPark Admin account. Example of replaced configuration: @@ -1053,9 +1048,9 @@ docker-compose up -d After execution, the following images will be displayed: -![](images/2024-10-30/6a1b5e6f3ca7901e5631afaba4dd2e717499af0b03fc9dd34ca9c2b2ab2bd6db.png) +![](images/2024-10-30/6a1b5e6f3ca7901e5631afaba4dd2e717499af0b03fc9dd34ca9c2b2ab2bd6db.png) -![](images/2024-10-30/1d2de0b208aa28ac46435bf43739fb9fc5e76e8724122883adebd540aff582a7.png) +![](images/2024-10-30/1d2de0b208aa28ac46435bf43739fb9fc5e76e8724122883adebd540aff582a7.png) #### Independently Deploy API Gateway @@ -1129,20 +1124,20 @@ peer: # Configuration information for communication between cluster nodes **Configuration Description** -| Field Name | Description | -| :------------------------ | :----------------------------------------------------------- | -| version | Configuration version number, default is 2 | -| client | openAPI configuration information | -| client -> listen_urls | List of openAPI listening addresses, format: `{protocol}://{IP}:{port}` | -| client -> advertise_urls | List of openAPI broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | -| client -> certificate | List of openAPI certificate information | -| gateway | Configuration information for forwarding proxy core program | -| gateway -> listen_urls | List of forwarding proxy core program listening addresses, format: `{protocol}://{IP}:{port}` | -| gateway -> advertise_urls | List of forwarding proxy core program broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | -| peer | Configuration information for Raft nodes, used for configuration synchronization, joining the cluster, leaving the cluster, etc. | -| peer -> listen_urls | List of Raft node listening addresses, format: `{protocol}://{IP}:{port}` | -| peer -> advertise_urls | List of Raft node broadcast addresses, format: `{protocol}://{IP/domain}:{port}` | -| peer -> certificate | List of Raft node certificate information | +| Field Name | Description | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| version | Configuration version number, default is 2 | +| client | openAPI configuration information | +| client -> listen\_urls | List of openAPI listening addresses, format: `{protocol}://{IP}:{port}` | +| client -> advertise\_urls | List of openAPI broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | +| client -> certificate | List of openAPI certificate information | +| gateway | Configuration information for forwarding proxy core program | +| gateway -> listen\_urls | List of forwarding proxy core program listening addresses, format: `{protocol}://{IP}:{port}` | +| gateway -> advertise\_urls | List of forwarding proxy core program broadcast addresses, displayed in the console cluster node list, format: `{protocol}://{IP/domain}:{port}` | +| peer | Configuration information for Raft nodes, used for configuration synchronization, joining the cluster, leaving the cluster, etc. | +| peer -> listen\_urls | List of Raft node listening addresses, format: `{protocol}://{IP}:{port}` | +| peer -> advertise\_urls | List of Raft node broadcast addresses, format: `{protocol}://{IP/domain}:{port}` | +| peer -> certificate | List of Raft node certificate information | 3. Run Docker container and mount configuration file `config.yml` @@ -1157,7 +1152,6 @@ docker run -td -p 8099:8099 -p 9400:9400 -p 9401:9401 --privileged=true \ #### Build API Gateway Cluster 1. Deploy a new node on another server following the **deployment steps** above - 2. After deployment, enter the Docker container of any node (this step can be ignored for **installation package deployment**) ``` @@ -1172,8 +1166,8 @@ docker exec -it apinto_node bash In the above command, values within `{}` are variables and need to be replaced with actual values. -- IP: Server IP -- Port number: Raft node communication port number in `config.yml` under the `peer` configuration section +* IP: Server IP +* Port number: Raft node communication port number in `config.yml` under the `peer` configuration section An example is shown below: @@ -1199,9 +1193,7 @@ The one-click deployment script installs the InfluxDB database by default. After 2. Fill in the initialization information, including username, password, organization name, and Bucket name. -:::warning -Here, fill `apipark` for `Organization Name` and `apinto` for `Bucket Name`. -::: +:::warning Here, fill `apipark` for `Organization Name` and `apinto` for `Bucket Name`. ::: ![](images/2024-10-29-02-20-19.png) @@ -1233,4 +1225,4 @@ InfluxDB's API Tokens are tokens used for authentication and authorization, allo 4. Copy the generated `API Token`, which will be needed later when [setting up APIPark data source](system_setting/data_source.md). -![](images/2024-10-29-02-20-59.png) \ No newline at end of file +![](images/2024-10-29-02-20-59.png) diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md index 81d65c4..dea971a 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/developer_portal.md @@ -1,6 +1,7 @@ --- sidebar_position: 7 title: 🔎 API Developer Portal +icon: rectangle-code --- # API Developer Portal diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/release.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/release.md index 03169ee..96d6408 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/release.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/release.md @@ -1,32 +1,34 @@ --- sidebar_position: 2 -title: "📜 Changelog" +title: 📜 Changelog +icon: scroll --- # Changelog ## 🎉 V1.4 Beta -- Added support for AI model load balancing, enabling smooth failover when the original AI provider is inaccessible, ensuring your customers are not affected by the provider's issues. -- Introduced support for an AI API KEY resource pool, allowing multiple API keys for the same AI provider to be entered, with the system automatically managing available API keys, overcoming original factory restrictions. -- Added support for token consumption statistics of AI APIs, allowing you to view the number of tokens consumed when calling various AI services' APIs over a specified time range. +* Added support for AI model load balancing, enabling smooth failover when the original AI provider is inaccessible, ensuring your customers are not affected by the provider's issues. +* Introduced support for an AI API KEY resource pool, allowing multiple API keys for the same AI provider to be entered, with the system automatically managing available API keys, overcoming original factory restrictions. +* Added support for token consumption statistics of AI APIs, allowing you to view the number of tokens consumed when calling various AI services' APIs over a specified time range. ## 🎉 V1.3 Beta -- Introduced a data masking strategy feature to filter sensitive data during API calls, ensuring data security when interfacing with AI. -- Added data masking interception logs to query each intercepted interface log, identifying consumers and triggered content. -- Enhanced API service integration capability, allowing external systems to obtain corresponding API documentation data via URL, facilitating the rapid integration of business capabilities with AI agent platforms. -- Added multiple report statistic capabilities, supporting analysis of interface calls by service dimension or consumer dimension, assisting enterprises in comprehensive traffic management. +* Introduced a data masking strategy feature to filter sensitive data during API calls, ensuring data security when interfacing with AI. +* Added data masking interception logs to query each intercepted interface log, identifying consumers and triggered content. +* Enhanced API service integration capability, allowing external systems to obtain corresponding API documentation data via URL, facilitating the rapid integration of business capabilities with AI agent platforms. +* Added multiple report statistic capabilities, supporting analysis of interface calls by service dimension or consumer dimension, assisting enterprises in comprehensive traffic management. ## 🎉 V1.2 Beta + APIPark introduces a brand new AI Service (AI Gateway) feature, supporting the quick integration of multiple AI models, helping developers rapidly integrate and call various AI models. APIPark simplifies the calling process through a unified API format, reducing the complexity of switching models, and supports encapsulating Prompts into standard REST APIs for API reuse and sharing. APIPark supports the full lifecycle management of APIs, including design, release, invocation, and deprecation processes, while also providing a subscription approval mechanism to enhance data security. 🦄 APIPark has been released on ProductHunt: -APIPark - #1ŌOpenŌSourceŌAIŌGatewayŌ&ŌAPIŌDeveloperŌPortal | Product Hunt - +[\APIPark - #1ŌOpenŌSourceŌAIŌGatewayŌ&ŌAPIŌDeveloperŌPortal | Product Hunt](https://www.producthunt.com/posts/apipark?embed=true\&utm_source=badge-featured\&utm_medium=badge\&utm_souce=badge-apipark) ✨ Updates: + 1. Support creating AI services, using a uniformly formatted Unified API to access 100+ AI models. 2. AI Services support converting Prompt instructions to standard REST APIs for easy management and use of Prompts. 3. AI Services support auto-generating API documentation. @@ -37,15 +39,15 @@ APIPark introduces a brand new AI Service (AI Gateway) feature, supporting the q 8. "Application" changed to "Consumer" for easier understanding of product concepts. 9. Fixed known defects. -❤️ Thanks to the following Github users for their suggestions that made APIPark better, in no particular order: -@BeatlessLDJ, @jeak01, @Saury-t, @anyachuan, @dashenbibi, @DukeChaos2023, @Tropical-Strom, @NINGyv179, @EthanLeeDev, @Changeeer, @sunanzhi, @maggieyyy, @guowanjing, @marsdxx, @riverLethe, @scarqin, @krystalisa, @yingjoumong8, @snycloud, @yingjoumong8 - +❤️ Thanks to the following Github users for their suggestions that made APIPark better, in no particular order: @BeatlessLDJ, @jeak01, @Saury-t, @anyachuan, @dashenbibi, @DukeChaos2023, @Tropical-Strom, @NINGyv179, @EthanLeeDev, @Changeeer, @sunanzhi, @maggieyyy, @guowanjing, @marsdxx, @riverLethe, @scarqin, @krystalisa, @yingjoumong8, @snycloud, @yingjoumong8 ## 🎉 V1.1 Beta + ✨ Updates: + 1. Released a demo website, welcome to visit https://demo.apipark.com to experience the product. 2. Added Japanese and traditional Chinese languages. 3. Included beginner guides. 4. Introduced analysis statistics to easily understand internal enterprise API calls. 5. Enhanced API documentation, fully supporting OpenAPI V2.0 and V3.0 formats, allowing uploading of OpenAPI YAML files to create API documents. -6. Improved product experience. \ No newline at end of file +6. Improved product experience. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md index 55f5101..4d419c5 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/services/README.md @@ -1,2 +1,6 @@ +--- +icon: robot +--- + # Services diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md index 0595267..cbf703f 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/system_setting/README.md @@ -1,2 +1,6 @@ +--- +icon: gear +--- + # System Settings diff --git a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/teams.md b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/teams.md index 21f0aa3..027fb25 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/teams.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-1.4-beta/teams.md @@ -1,6 +1,7 @@ --- sidebar_position: 6 -title: "🤝 Team" +title: 🤝 Team +icon: user-group --- # Team @@ -10,16 +11,18 @@ In APIPark, you can create multiple teams. A team is similar to the concept of a ![](images/2024-10-28-22-11-37.png) ## Create a Team + Go to the **Workspace** module, select **Team** in the sidebar, and then click **Create Team** and fill in the following details: -- **Team Name** -- **Team ID**: A unique identifier for the team, which cannot be changed once saved. -- **Team Administrator**: The team admin has the highest privileges within the team, able to manage members, add services, and consumers within the team. -- **Description** +* **Team Name** +* **Team ID**: A unique identifier for the team, which cannot be changed once saved. +* **Team Administrator**: The team admin has the highest privileges within the team, able to manage members, add services, and consumers within the team. +* **Description** ![](images/cd907e5cc59c79d0f0.png) ## Add Members to the Team + In the team details page, select **Members** in the sidebar, and then click **Add Member**. In the popup, choose the member you want to add to the team. > 💡 When adding team members, you can only choose from the list of accounts in APIPark. If you haven't created an APIPark account for the members, please refer to [🔗 Manage APIPark Account](system_setting/account_role.md) @@ -27,11 +30,13 @@ In the team details page, select **Members** in the sidebar, and then click **Ad ![](images/2024-10-28-21-53-07.png) ## Create AI Services + APIPark's AI Service (AI Gateway) provides unified access management for multiple AI models, helping developers quickly integrate and call various AI models. It simplifies the calling process with a standardized API format, reduces the complexity of model switching, and supports encapsulating prompts into standard REST APIs for easier API reuse and sharing. APIPark supports full API lifecycle management, including the entire process from design, publishing, to calling and deprecation, and provides a subscription approval mechanism to enhance data security. If you need to create AI services within the team, please visit [🔗 Create AI Services](services/ai_services.md) ## Create REST Services + APIPark has a powerful cloud-native API gateway that offers better performance than Nginx and supports cluster deployments for large-scale traffic. By sharing REST APIs within the team through APIPark and managing API call relationships, you can avoid management costs and data leakage problems caused by chaotic API calls. @@ -39,8 +44,9 @@ By sharing REST APIs within the team through APIPark and managing API call relat If you need to create REST services within the team, please visit [🔗 Create REST Services](services/rest_services.md) ## Create Consumers + In APIPark, a **Consumer** is an entity that **subscribes to services** and **calls APIs**. Consumers gain the right to call the APIs within the service by subscribing, ensuring data security and compliance with access rights. Consumers support various authentication methods, including API Key, Basic, JWT, and AK/SK, to meet different application security requirements. -If you need to create consumers within the team, please visit [🔗 Create Consumers](consumers.md) \ No newline at end of file +If you need to create consumers within the team, please visit [🔗 Create Consumers](consumers.md) From 30d2470a3ccc7faa65fe0424d918f02f5f3c14a4 Mon Sep 17 00:00:00 2001 From: Addison Schultz Date: Mon, 10 Feb 2025 07:35:18 +0000 Subject: [PATCH 4/4] GITBOOK-2: No subject --- docs/README.md | 1 + docs/ai/README.md | 4 ++ docs/analysis.md | 11 ++- docs/call_api.md | 28 ++++---- docs/consumers.md | 25 +++---- docs/deploy.md | 129 ++++++++++++++++------------------ docs/developer_portal.md | 1 + docs/release.md | 30 ++++---- docs/services/README.md | 4 ++ docs/system_setting/README.md | 4 ++ docs/teams.md | 20 +++--- 11 files changed, 131 insertions(+), 126 deletions(-) diff --git a/docs/README.md b/docs/README.md index b0f7458..534b25b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: 🦄 概述 +icon: alicorn --- # 概述 diff --git a/docs/ai/README.md b/docs/ai/README.md index 3a48836..0ce6e55 100644 --- a/docs/ai/README.md +++ b/docs/ai/README.md @@ -1,2 +1,6 @@ +--- +icon: sparkles +--- + # AI diff --git a/docs/analysis.md b/docs/analysis.md index 4a16032..07327ca 100644 --- a/docs/analysis.md +++ b/docs/analysis.md @@ -1,14 +1,13 @@ --- sidebar_position: 9 -title: "📊 分析报告" +title: 📊 分析报告 +icon: file-chart-column --- -# API 调用分析报告 +# API 调用分析报告 APIPark 通过对历史调用数据的分析， 展示 API 长期的调用趋势和性能变化，帮助企业维持 API 的稳定。 -> 💡 APIPark 的 API 调用分析报告依赖于 InfluxDB 数据库。如果你使用 APIPark 官方提供的脚本部署，默认会安装 InfluxDB，了解更多：[🔗 部署 APIPark](deploy.md)。 -> 💡 你也可以部署外部的 InfluxDB 数据库，然后在 APIPark 的系统设置中填写 InfluxDB 的数据源信息，了解更多：[🔗 设置数据源](system_setting/data_source.md)。 +> 💡 APIPark 的 API 调用分析报告依赖于 InfluxDB 数据库。如果你使用 APIPark 官方提供的脚本部署，默认会安装 InfluxDB，了解更多：[🔗 部署 APIPark](deploy.md)。 💡 你也可以部署外部的 InfluxDB 数据库，然后在 APIPark 的系统设置中填写 InfluxDB 的数据源信息，了解更多：[🔗 设置数据源](system_setting/data_source.md)。 - -![](images/2024-10-28/bd920673b71b05514a44eab4e18a64f50aea2ab69f629687aea46b346bcbf51c.png) +![](images/2024-10-28/bd920673b71b05514a44eab4e18a64f50aea2ab69f629687aea46b346bcbf51c.png) diff --git a/docs/call_api.md b/docs/call_api.md index 2fbc92b..8fd2c3c 100644 --- a/docs/call_api.md +++ b/docs/call_api.md @@ -1,6 +1,7 @@ --- sidebar_position: 8 -title: "🔗 调用 API" +title: 🔗 调用 API +icon: cloud-bolt --- # 调用API @@ -9,35 +10,30 @@ title: "🔗 调用 API" 在调用前需要满足以下条件： -- **消费者** 已经创建了 **授权证书**，了解更多：[🔗 消费者](consumers.md)。 -- **消费者** 已经成功订阅了服务，了解更多：[🔗 API 门户](developer_portal.md)。 - +* **消费者** 已经创建了 **授权证书**，了解更多：[🔗 消费者](consumers.md)。 +* **消费者** 已经成功订阅了服务，了解更多：[🔗 API 门户](developer_portal.md)。 ## 示例 😜 假设: -- **消费者** 的 **授权证书**： - - **认证类型**：API Key - - **参数位置**：Header - - **参数名称**：Authorization - - **密钥**：96f55...ee4 -- **服务** 的 API 调用地址为： **http://api.apipark.com/cda53bf2/demo_translation_api** - -![](images/2024-10-28/5fbe42033e3fb02015f4ef886efd6b9d09ed560252a1fd2a35a94df3ebec5e16.png) +* **消费者** 的 **授权证书**： + * **认证类型**：API Key + * **参数位置**：Header + * **参数名称**：Authorization + * **密钥**：96f55...ee4 +* **服务** 的 API 调用地址为： **http://api.apipark.com/cda53bf2/demo\_translation\_api** +![](images/2024-10-28/5fbe42033e3fb02015f4ef886efd6b9d09ed560252a1fd2a35a94df3ebec5e16.png) 您可以使用以下任意一种方式进行调用服务API。 - - ### Postman or Other API Clients 在 API 测试工具中，在 Header 中添加 Authorization 参数，并且将参数值设置为 96f55...ee4： ![](images/2024-10-29-01-47-24.png) - ### cURL 在命令行中输入： @@ -46,4 +42,4 @@ title: "🔗 调用 API" curl -X POST -H "Authorization: 96f55...ee4" \ -H "Content-Type: application/json" -d "request body content" \ http://api.apipark.com/cda53bf2/demo_translation_api -``` \ No newline at end of file +``` diff --git a/docs/consumers.md b/docs/consumers.md index 7e6607b..acf5282 100644 --- a/docs/consumers.md +++ b/docs/consumers.md @@ -1,9 +1,11 @@ --- sidebar_position: 5 -title: "⌨️ 消费者" +title: ⌨️ 消费者 +icon: keyboard --- # 消费者 + APIPark 提供了 **API 门户** 功能，用户可以将服务发布到 API 门户并且被其他用户查看、订阅和调用。 在 APIPark 中，**消费者（Consumer）** 是 **订阅服务** 和 **调用API** 的实体，消费者通过订阅服务来获得调用服务内API的权限，确保数据安全和访问权限合规。 @@ -12,16 +14,15 @@ APIPark 提供了 **API 门户** 功能，用户可以将服务发布到 API 门 ![](images/2024-10-28-23-05-08.png) - ## 创建消费者 订阅 API 服务之前，你需要先创建一个**消费者（Consumer）**，消费者是 **订阅服务** 和 **调用API** 的实体，消费者通过订阅服务来获得调用服务内API的权限，确保数据安全和访问权限合规。 进入 **工作空间** 模块，在侧边栏中选择 **消费者**，然后 **创建消费者**，填写： -- **消费者名称** -- **消费者 ID**：消费者的唯一标识，一旦保存无法修改。 -- **描述** +* **消费者名称** +* **消费者 ID**：消费者的唯一标识，一旦保存无法修改。 +* **描述** ![](images/2024-10-28-23-09-51.png) @@ -31,12 +32,12 @@ APIPark 通过 **授权证书** 限制 **消费者** 对 API 资源的访问， 进入 **消费者** 的管理界面，在侧边栏选择 **授权证书**，然后点击 **创建授权证书**，在弹窗中填写： -- **证书名称**：为了便于管理密钥，建议为密钥设置清晰易懂的名称。 -- **认证类型**：证书的认证方式，包括Basic Auth、API Key、JWT、AK/SK等，每个认证方式有不同的参数填写位置和密钥规则。 -- **参数位置**：密钥填写的位置。 -- **密钥**：请求 APIPark 的 API 时，需要在请求参数中填写密钥。为了避免数据泄露，请不要将密钥存储在公开的代码中。 -- **过期时间**：授权证书默认是永不过期，如果你希望创建一个临时的授权证书，比如仅三个月有效，可以填写过期时间。通过过期的授权证书访问 APIPark 时，APIPark 会返回授权证书失效的错误提示。 -- **隐藏认证信息**：APIPark 的 API 网关默认会在转发 API 请求时，将消费者的授权证书发送给上游（Upstream）服务，便于上游服务对授权进行二次验证。如果勾选该选项，则 APIPark 在转发API请求时会隐藏授权信息。 +* **证书名称**：为了便于管理密钥，建议为密钥设置清晰易懂的名称。 +* **认证类型**：证书的认证方式，包括Basic Auth、API Key、JWT、AK/SK等，每个认证方式有不同的参数填写位置和密钥规则。 +* **参数位置**：密钥填写的位置。 +* **密钥**：请求 APIPark 的 API 时，需要在请求参数中填写密钥。为了避免数据泄露，请不要将密钥存储在公开的代码中。 +* **过期时间**：授权证书默认是永不过期，如果你希望创建一个临时的授权证书，比如仅三个月有效，可以填写过期时间。通过过期的授权证书访问 APIPark 时，APIPark 会返回授权证书失效的错误提示。 +* **隐藏认证信息**：APIPark 的 API 网关默认会在转发 API 请求时，将消费者的授权证书发送给上游（Upstream）服务，便于上游服务对授权进行二次验证。如果勾选该选项，则 APIPark 在转发API请求时会隐藏授权信息。 ![](images/2024-10-28-23-15-15.png) @@ -46,4 +47,4 @@ APIPark 通过 **授权证书** 限制 **消费者** 对 API 资源的访问， ## 通过消费者来调用 API -如果需要调用服务的 API，请查看 [🔗 调用 API](call_api.md) \ No newline at end of file +如果需要调用服务的 API，请查看 [🔗 调用 API](call_api.md) diff --git a/docs/deploy.md b/docs/deploy.md index 315da6b..506d6e1 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -1,30 +1,28 @@ --- sidebar_position: 3 title: 🚀 部署 APIPark +icon: rocket-launch --- # 部署 APIPark + ## 硬件要求 -:::tip -建议配置： +:::tip 建议配置： -- **CPU**：8核 -- **内存**：16G -- **硬盘存储**：200G -- **操作系统**：Linux / Mac -- **系统架构**：AMD64 / ARM64 -::: +* **CPU**：8核 +* **内存**：16G +* **硬盘存储**：200G +* **操作系统**：Linux / Mac +* **系统架构**：AMD64 / ARM64 ::: -:::note -最低配置： +:::note 最低配置： -- **CPU**：2核 -- **内存**：4G -- **硬盘存储**：200G -- **操作系统**：Linux / Mac -- **系统架构**：AMD64 / ARM64 -::: +* **CPU**：2核 +* **内存**：4G +* **硬盘存储**：200G +* **操作系统**：Linux / Mac +* **系统架构**：AMD64 / ARM64 ::: ## 程序依赖 @@ -36,8 +34,7 @@ title: 🚀 部署 APIPark ### 使用脚本部署 -:::note -支持的系统列表： +:::note 支持的系统列表： * CentOS 7.9（7.x为代表） * CentOS 8.5（8.x为代表） @@ -47,8 +44,7 @@ title: 🚀 部署 APIPark * Alibaba Cloud Linux 3.2104 * Alibaba Cloud Linux 2.1903 -当前仅测试了上述部署的安装，若需要其他系统的一键部署，可给我们提交[Issue](https://github.com/APIParkLab/APIPark/issues)。 -::: +当前仅测试了上述部署的安装，若需要其他系统的一键部署，可给我们提交[Issue](https://github.com/APIParkLab/APIPark/issues)。 ::: 输入一键部署指令： @@ -64,7 +60,7 @@ curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start. 使用此方法安装 APIPark，你需要安装 [Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/)。 -部署完成后，APIPark需要绑定API网关节点才可使用，具体教程请参考[配置API网关](./system_setting/api_gateway_cluster.md) +部署完成后，APIPark需要绑定API网关节点才可使用，具体教程请参考[配置API网关](system_setting/api_gateway_cluster.md) ::: @@ -140,20 +136,20 @@ peer: # 集群间节点通信配置信息 **配置说明** -| 字段名称 | 说明 | -| :------------------------ | :----------------------------------------------------------- | -| version | 配置版本号，默认2 | -| client | openAPI配置信息 | -| client -> listen_urls | openAPI监听地址列表，格式：`{协议}://{IP}:{端口}` | -| client -> advertise_urls | openAPI广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | -| client -> certificate | openAPI证书信息列表 | -| gateway | 转发代理核心程序配置信息 | -| gateway -> listen_urls | 转发代理核心程序监听地址列表，格式：`{协议}://{IP}:{端口}` | -| gateway -> advertise_urls | 转发代理核心程序广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | -| peer | Raft节点配置信息，用于Raft集群节点配置同步、加入集群、离开集群等操作的通信 | -| peer -> listen_urls | Raft节点监听地址列表，格式：`{协议}://{IP}:{端口}` | -| peer -> advertise_urls | Raft节点广播地址列表，格式：`{协议}://{IP/域名}:{端口}` | -| peer -> certificate | Raft节点证书信息列表 | +| 字段名称 | 说明 | +| -------------------------- | ----------------------------------------------------- | +| version | 配置版本号，默认2 | +| client | openAPI配置信息 | +| client -> listen\_urls | openAPI监听地址列表，格式：`{协议}://{IP}:{端口}` | +| client -> advertise\_urls | openAPI广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | +| client -> certificate | openAPI证书信息列表 | +| gateway | 转发代理核心程序配置信息 | +| gateway -> listen\_urls | 转发代理核心程序监听地址列表，格式：`{协议}://{IP}:{端口}` | +| gateway -> advertise\_urls | 转发代理核心程序广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | +| peer | Raft节点配置信息，用于Raft集群节点配置同步、加入集群、离开集群等操作的通信 | +| peer -> listen\_urls | Raft节点监听地址列表，格式：`{协议}://{IP}:{端口}` | +| peer -> advertise\_urls | Raft节点广播地址列表，格式：`{协议}://{IP/域名}:{端口}` | +| peer -> certificate | Raft节点证书信息列表 | 3. 编辑`docker-compose.yml`文件 @@ -384,9 +380,9 @@ networks: 上述配置中，使用 "{}" 包裹的均为变量，相关变量说明如下： -- **MYSQL_PWD：**mysql数据库root用户初始化密码 -- **REDIS_PWD：**redis密码 -- **ADMIN_PASSWORD：**APIPark Admin账号初始密码 +* \*\*MYSQL\_PWD：\*\*mysql数据库root用户初始化密码 +* \*\*REDIS\_PWD：\*\*redis密码 +* \*\*ADMIN\_PASSWORD：\*\*APIPark Admin账号初始密码 替换后配置示例如下： @@ -618,10 +614,9 @@ docker-compose up -d 执行完成后，将出现如下图所示： -![](images/2024-10-30/0d4ef04a942f1a6e47c6b43ddeda1d0c5e7f8a4ff4b6c7ffde08c4594481bee4.png) - +![](images/2024-10-30/0d4ef04a942f1a6e47c6b43ddeda1d0c5e7f8a4ff4b6c7ffde08c4594481bee4.png) -![](images/2024-10-30/bcd15ba41f68be367f87ff38709f1fb60f3de5e8c24b4b658b2e4bd8afd7dcdb.png) +![](images/2024-10-30/bcd15ba41f68be367f87ff38709f1fb60f3de5e8c24b4b658b2e4bd8afd7dcdb.png) #### 单独部署APIPark @@ -837,9 +832,9 @@ networks: 上述配置中，使用 "{}" 包裹的均为变量，相关变量说明如下： -- **MYSQL_PWD：**mysql数据库root用户初始化密码 -- **REDIS_PWD：**redis密码 -- **ADMIN_PASSWORD：**APIPark Admin账号初始密码 +* \*\*MYSQL\_PWD：\*\*mysql数据库root用户初始化密码 +* \*\*REDIS\_PWD：\*\*redis密码 +* \*\*ADMIN\_PASSWORD：\*\*APIPark Admin账号初始密码 替换后配置示例如下： @@ -1052,10 +1047,9 @@ networks: docker-compose up -d ``` -执行完成后，将出现如下图所示： -![](images/2024-10-30/6a1b5e6f3ca7901e5631afaba4dd2e717499af0b03fc9dd34ca9c2b2ab2bd6db.png) +执行完成后，将出现如下图所示： ![](images/2024-10-30/6a1b5e6f3ca7901e5631afaba4dd2e717499af0b03fc9dd34ca9c2b2ab2bd6db.png) -![](images/2024-10-30/1d2de0b208aa28ac46435bf43739fb9fc5e76e8724122883adebd540aff582a7.png) +![](images/2024-10-30/1d2de0b208aa28ac46435bf43739fb9fc5e76e8724122883adebd540aff582a7.png) #### 单独部署API网关 @@ -1129,20 +1123,20 @@ peer: # 集群间节点通信配置信息 **配置说明** -| 字段名称 | 说明 | -| :------------------------ | :----------------------------------------------------------- | -| version | 配置版本号，默认2 | -| client | openAPI配置信息 | -| client -> listen_urls | openAPI监听地址列表，格式：`{协议}://{IP}:{端口} ` | -| client -> advertise_urls | openAPI广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | -| client -> certificate | openAPI证书信息列表 | -| gateway | 转发代理核心程序配置信息 | -| gateway -> listen_urls | 转发代理核心程序监听地址列表，格式：`{协议}://{IP}:{端口}` | -| gateway -> advertise_urls | 转发代理核心程序广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | -| peer | Raft节点配置信息，用于Raft集群节点配置同步、加入集群、离开集群等操作的通信 | -| peer -> listen_urls | Raft节点监听地址列表，格式：`{协议}://{IP}:{端口}` | -| peer -> advertise_urls | Raft节点广播地址列表，格式：`{协议}://{IP/域名}:{端口}` | -| peer -> certificate | Raft节点证书信息列表 | +| 字段名称 | 说明 | +| -------------------------- | ----------------------------------------------------- | +| version | 配置版本号，默认2 | +| client | openAPI配置信息 | +| client -> listen\_urls | openAPI监听地址列表，格式：`{协议}://{IP}:{端口}` | +| client -> advertise\_urls | openAPI广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | +| client -> certificate | openAPI证书信息列表 | +| gateway | 转发代理核心程序配置信息 | +| gateway -> listen\_urls | 转发代理核心程序监听地址列表，格式：`{协议}://{IP}:{端口}` | +| gateway -> advertise\_urls | 转发代理核心程序广播地址列表，在控制台集群节点列表中展示，格式：`{协议}://{IP/域名}:{端口}` | +| peer | Raft节点配置信息，用于Raft集群节点配置同步、加入集群、离开集群等操作的通信 | +| peer -> listen\_urls | Raft节点监听地址列表，格式：`{协议}://{IP}:{端口}` | +| peer -> advertise\_urls | Raft节点广播地址列表，格式：`{协议}://{IP/域名}:{端口}` | +| peer -> certificate | Raft节点证书信息列表 | 3. 运行Docker容器，并挂载配置文件`config.yml` @@ -1157,7 +1151,6 @@ docker run -td -p 8099:8099 -p 9400:9400 -p 9401:9401 --privileged=true \ #### 构建API网关集群 1. 在另一台服务器上按上述 **部署步骤** 部署一台新节点 - 2. 部署完成后，进入任一节点Docker容器（**安装包部署**可忽略该步骤） ``` @@ -1172,8 +1165,8 @@ docker exec -it apinto_node bash 上述命令，带有`{}`的为变量，需要根据情况填入实际的值 -- IP：服务器IP -- 端口号：Raft节点通信端口号，`config.yml` 中 `peer` 配置部分 +* IP：服务器IP +* 端口号：Raft节点通信端口号，`config.yml` 中 `peer` 配置部分 示例如下 @@ -1181,7 +1174,6 @@ docker exec -it apinto_node bash ./apinto join -addr 172.18.189.72:9401 ``` - ## 配置InfluxDB ### 初始化InfluxDB @@ -1200,9 +1192,7 @@ docker exec -it apinto_node bash 2. 填写初始化信息，包括用户名、密码、组织名称，Bucket名称。 -:::warning -此处的 `Organization Name` 填 `apipark` ，`Bucket Name` 填 `apinto`。 -::: +:::warning 此处的 `Organization Name` 填 `apipark` ，`Bucket Name` 填 `apinto`。 ::: ![](images/2024-10-29-02-20-19.png) @@ -1226,7 +1216,7 @@ InfluxDB 的 API Tokens 是用于认证和授权的令牌，允许用户和应 2. 生成 `All Access API Token`。 -![](images/2024-10-29-02-20-40.png) +![](images/2024-10-29-02-20-40.png) 3. 输入描述信息后，点击`SAVE`。 @@ -1235,4 +1225,3 @@ InfluxDB 的 API Tokens 是用于认证和授权的令牌，允许用户和应 4. 将生成的`API Token`复制，后续在[配置APIPark数据源](system_setting/data_source.md)时需要用到。 ![](images/2024-10-29-02-20-59.png) - diff --git a/docs/developer_portal.md b/docs/developer_portal.md index e796303..18bd80b 100644 --- a/docs/developer_portal.md +++ b/docs/developer_portal.md @@ -1,6 +1,7 @@ --- sidebar_position: 7 title: 🔎 API 开发者门户 +icon: rectangle-code --- # API 开发者门户 diff --git a/docs/release.md b/docs/release.md index ac5fa23..608aac0 100644 --- a/docs/release.md +++ b/docs/release.md @@ -1,32 +1,34 @@ --- sidebar_position: 2 -title: "📜 更新日志" +title: 📜 更新日志 +icon: scroll --- # 更新日志 ## 🎉 V1.4 Beta -- 新增支持 AI 模型负载均衡，当原定的 AI 服务商无法访问时实现平滑的故障转移，使您的客户不会受到 AI 服务商的异常影响。 -- 新增支持 AI APIKEY资源池，可针对同一 AI 服务商录入多个APIKEY，系统自动调度可用的APIKEY，摆脱原厂的各种限制。 -- 新增支持 AI API 的 token 消耗统计，可查看指定时间范围内，调用各AI服务的API所消耗的token数量。 +* 新增支持 AI 模型负载均衡，当原定的 AI 服务商无法访问时实现平滑的故障转移，使您的客户不会受到 AI 服务商的异常影响。 +* 新增支持 AI APIKEY资源池，可针对同一 AI 服务商录入多个APIKEY，系统自动调度可用的APIKEY，摆脱原厂的各种限制。 +* 新增支持 AI API 的 token 消耗统计，可查看指定时间范围内，调用各AI服务的API所消耗的token数量。 ## 🎉 V1.3 Beta -- 新增数据脱敏策略功能，可对API调用中的敏感数据进行过滤，保障与AI对接时的数据安全。 -- 新增数据脱敏拦截日志，可对每一次拦截的接口日志进行查询，发现消费者和触发内容。 -- 新增API服务集成能力，外部系统可通过URL获取对应API文档数据，助力业务能力快速对接AI agent平台。 -- 新增多种报表统计能力，支持按服务维度或按消费者维度分析接口调用情况，协助企业全面管控流量。 +* 新增数据脱敏策略功能，可对API调用中的敏感数据进行过滤，保障与AI对接时的数据安全。 +* 新增数据脱敏拦截日志，可对每一次拦截的接口日志进行查询，发现消费者和触发内容。 +* 新增API服务集成能力，外部系统可通过URL获取对应API文档数据，助力业务能力快速对接AI agent平台。 +* 新增多种报表统计能力，支持按服务维度或按消费者维度分析接口调用情况，协助企业全面管控流量。 ## 🎉 V1.2 Beta + APIPark 带来全新的 AI Service (AI Gateway)功能，支持快速接入多个 AI 模型，帮助开发者快速集成和调用各种 AI 模型。APIPark 通过统一的 API 格式来简化调用过程，减少切换模型的复杂性，并且支持将 Prompt 封装成标准 REST API，以便于 API 的复用和共享。APIPark 支持 API 全生命周期的管理，包括从设计、发布到调用和下线的全过程，同时还提供订阅审批机制，有助于提高数据安全性。 🦄 APIPark 已经发布到 ProductHunt： -APIPark - #1 Open Source AI Gateway & API Developer Portal | Product Hunt - +[\APIPark - #1 Open Source AI Gateway & API Developer Portal | Product Hunt](https://www.producthunt.com/posts/apipark?embed=true\&utm_source=badge-featured\&utm_medium=badge\&utm_souce=badge-apipark) ✨ 更新： + 1. 支持创建 AI 服务，使用格式统一的聚合 API （Unified API）接入 100+ AI 模型。 2. AI 服务支持将 Prompt 提示词转换为标准 REST API，便于管理和使用 Prompt 提示词。 3. AI 服务支持自动生成API文档。 @@ -37,15 +39,15 @@ APIPark 带来全新的 AI Service (AI Gateway)功能，支持快速接入多个 8. “应用 Application”改为“消费者 Consumer”，让产品概念更容易理解。 9. 修复已知的缺陷。 -❤️ 感谢以下Github用户的建议让 APIPark 变得更好，排名不分先后： -@BeatlessLDJ，@jeak01，@Saury-t，@anyachuan，@dashenbibi，@DukeChaos2023，@Tropical-Strom，@NINGyv179，@EthanLeeDev，@Changeeer，@sunanzhi，@maggieyyy，@guowanjing，@marsdxx，@riverLethe，@scarqin，@krystalisa，@yingjoumong8，@snycloud，@yingjoumong8 - +❤️ 感谢以下Github用户的建议让 APIPark 变得更好，排名不分先后： @BeatlessLDJ，@jeak01，@Saury-t，@anyachuan，@dashenbibi，@DukeChaos2023，@Tropical-Strom，@NINGyv179，@EthanLeeDev，@Changeeer，@sunanzhi，@maggieyyy，@guowanjing，@marsdxx，@riverLethe，@scarqin，@krystalisa，@yingjoumong8，@snycloud，@yingjoumong8 ## 🎉 V1.1 Beta + ✨ 更新： + 1. 发布Demo网站，欢迎访问 https://demo.apipark.com 体验产品 2. 新增日语、繁体中文语言 3. 加入新手引导 4. 加入分析统计，方便了解企业内部API调用情况 5. 强化API文档，全面支持 OpenAPI V2.0、V3.0 格式，可以上传 OpenAPI YAML 文件创建 API 文档 -6. 优化产品体验 \ No newline at end of file +6. 优化产品体验 diff --git a/docs/services/README.md b/docs/services/README.md index a41238f..db16dbd 100644 --- a/docs/services/README.md +++ b/docs/services/README.md @@ -1,2 +1,6 @@ +--- +icon: robot +--- + # 服务 diff --git a/docs/system_setting/README.md b/docs/system_setting/README.md index 72cdf52..4ecce1b 100644 --- a/docs/system_setting/README.md +++ b/docs/system_setting/README.md @@ -1,2 +1,6 @@ +--- +icon: gear +--- + # 系统设置 diff --git a/docs/teams.md b/docs/teams.md index b925391..74cb782 100644 --- a/docs/teams.md +++ b/docs/teams.md @@ -1,6 +1,7 @@ --- sidebar_position: 6 -title: "🤝 团队" +title: 🤝 团队 +icon: user-group --- # 团队 @@ -10,18 +11,18 @@ title: "🤝 团队" ![](images/2024-10-28-22-11-37.png) ## 创建团队 + 进入 **工作空间** 模块，在侧边栏中选择 **团队**，然后 **创建团队**，填写： -- **团队名称** -- **团队 ID**：团队的唯一标识，一旦保存无法修改。 -- **团队管理员**：团队管理员拥有团队内的最高权限，能够在团队内管理成员、添加服务和消费者等。 -- **描述** +* **团队名称** +* **团队 ID**：团队的唯一标识，一旦保存无法修改。 +* **团队管理员**：团队管理员拥有团队内的最高权限，能够在团队内管理成员、添加服务和消费者等。 +* **描述** ![](images/cd907e5cc59c79d0f0.png) - - ## 为团队添加成员 + 在团队详情页面，在侧边栏中选择 **成员**，然后点击 **添加成员**，在弹窗中选择需要加入团队的成员。 > 💡 添加团队成员时，只能从 APIPark 的账号列表中选择成员，如果你还没有为成员创建 APIPark 账号，请查看 [🔗 管理 APIPark 账号](system_setting/account_role.md) @@ -29,11 +30,13 @@ title: "🤝 团队" ![](images/2024-10-28-21-53-07.png) ## 创建 AI 服务 + APIPark 的 AI Service (AI Gateway) 提供了对多个 AI 模型的统一接入管理，帮助开发者快速集成和调用各种 AI 模型。APIPark 通过统一的 API 格式来简化调用过程，减少切换模型的复杂性，并且支持将 Prompt 封装成标准 REST API，以便于 API 的复用和共享。APIPark 支持 API 全生命周期的管理，包括从设计、发布到调用和下线的全过程，同时还提供订阅审批机制，有助于提高数据安全性。 如果需要在团队内创建 AI 服务，请查看 [🔗 创建 AI 服务](services/ai_services.md) ## 创建 REST 服务 + APIPark 内置了强大的云原生 API 网关，拥有比 Nginx 更高的性能，并且支持集群部署，能够支持大规模的流量。 通过 APIPark 将 REST API 在团队内共享，并管理API的调用关系，能够避免因混乱的API调用导致的管理成本和数据泄露问题。 @@ -41,8 +44,9 @@ APIPark 内置了强大的云原生 API 网关，拥有比 Nginx 更高的性能 如果需要在团队内创建 REST 服务，请查看 [🔗 创建 REST 服务](services/rest_services.md) ## 创建消费者 + 在 APIPark 中，**消费者（Consumer）** 是 **订阅服务** 和 **调用API** 的实体，消费者通过订阅服务来获得调用服务内API的权限，确保数据安全和访问权限合规。 消费者支持多种鉴权方式，包括API Key、Basic、JWT、以及AK/SK等方式，满足不同应用场景的安全需求。 -如果需要在团队内创建消费者，请查看 [🔗 创建消费者](consumers.md) \ No newline at end of file +如果需要在团队内创建消费者，请查看 [🔗 创建消费者](consumers.md)