diff --git a/README.md b/README.md index cd1afd74..9b4fab82 100644 --- a/README.md +++ b/README.md @@ -3,28 +3,53 @@

English | + 日本語 + | 简体中文 + | + 繁體中文

-🦄APIPark is the #1 open-source AI Gateway and Developer Portal, enabling you to easily manage, integrate, and deploy AI and API services. APIPark Easily connect to powerful AI models and package them as APIs for effortless use. - -✨Additionally, APIPark provides robust API management features, including API creation, monitoring, and access control, ensuring developers can efficiently and securely develop and manage their APIs. +🦄 APIPark is an open-source, all-in-one AI gateway and API developer portal, helping developers and enterprises easily manage, integrate, and deploy AI services. APIPark is open-sourced under the Apache 2.0 license, which means it's free for commercial use!
-# ✨ Quick Start -APIPark is dedicated to providing a one-stop AI & API open platform for enterprises and developers, open-sourced under the Apache 2.0 license. +✨ With APIPark, you can: +1. Quickly connect to 100+ AI models, supporting all mainstream AI Companies! +2. Combine AI models and prompt templates into APIs, such as creating a sentiment analysis API, translation API, or data analysis API based on OpenAI GPT-4 and some custom prompts. +3. Standardize the data format of all AI API requests, so switching AI models or modifying prompts won’t affect your APP or microservices, simplifying your AI usage and maintenance costs. +4. Share APIs within the team through APIPark's developer portal. +5. Manage calling applications and API keys to ensure your API's security and stability. +6. Monitor your AI API usage with clear charts. +7. Quickly export API request logs to third-party logging platforms. -APIPark aims to solve the following challenges: -- Easily connect to powerful AI models and package them as APIs for effortless use. +
+ +✨ APIPark is also a powerful cloud-native API gateway: +1. It outperforms Nginx with higher performance, supports cluster deployment, and handles large-scale traffic. +2. Share REST APIs within the team, manage API call relationships, and prevent management costs and data breaches caused by chaotic API calls. + + +
+ +# 💌 Why Did We Build APIPark? +Before building APIPark, we spent seven successful years developing an API development and automated testing platform with over 1 million developer users, 500+ enterprise customers, and multi-million-dollar investment from Sequoia Capital. + +As AI and Agents evolved, we noticed many enterprises wanted to integrate AI into both internal and third-party APIs, enabling AI agents to perform more complex tasks beyond being just knowledge-based Q&A bots. Hence, we built APIPark—your all-in-one AI gateway and API developer portal to accelerate your AI API development and quickly build your product or AI agent! + +
+ +# ✨ Quick Start +APIPark is designed to solve the following problems: +- Seamlessly connect to various AI models and package these AI capabilities into APIs for easy calling, significantly reducing the barrier to using AI models. - Manage complex AI & API call relationships. -- Oversee API creation, monitoring, and security. -- Fault detection and troubleshooting: Simplify the identification and resolution of system issues. -- Quantify the value of data assets: Enhance visibility and valuation of data assets." +- Manage API creation, monitoring, and security. +- Fault detection and troubleshooting: Simplifying system issue identification and resolution. +- Quantify data asset value: Enhance the visibility and valuation of data assets.
-😍 APIPark deployment is very simple, just one command line can deploy your API open platform in 5 minutes. +😍 Deploying APIPark is incredibly simple. With just one command line, you can deploy your AI gateway and API developer portal in under 5 minutes. ``` curl -sSO https://download.apipark.com/install/quick-start.sh ; bash quick-start.sh @@ -32,131 +57,171 @@ curl -sSO https://download.apipark.com/install/quick-start.sh ; bash quick-sta
-# 🔥 characteristic +# 🔥 Features - - - + + + - + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + - + + + + - - - - + + + + - - - - - - - - - - + + + +
-Centralize management and display of all API services within the enterprise - -Covering the entire process of API design, release, operation, and deployment -
+ Connect to 100+ major models from all mainstream AI Companies + + Standardize all AI API call formats, with no additional adaptation work required +
- -API Service Square is one of the core functions of APIPark, aimed at solving the problem of scattered and chaotic management of APIs within enterprises. Through API Service Square, enterprises can display all API services on a unified platform, making it easy for different departments and teams to find and use the required API services. - - -The API lifecycle management function helps enterprises standardize the API management process, manage API traffic forwarding and load balancing, and manage all API versions released to the public. Improve the quality and maintainability of APIs. Through this feature, enterprises can achieve efficient API development and stable operation, thereby supporting rapid business development and innovation. -
+ + The API Service Plaza is one of APIPark’s core features, aiming to solve the problem of fragmented and chaotic internal API management in enterprises. Through the API Service Plaza, enterprises can showcase all API services on a unified platform, allowing different departments and teams to easily find and use the required API services. + + + The full API lifecycle management feature helps enterprises standardize the API management process, manage API traffic forwarding and load balancing, and oversee all API versions published externally. This improves API quality and maintainability, enabling efficient development and stable operation to support rapid business growth and innovation. +
+ Combine AI models and prompt templates to form new AI APIs + + Switching AI models or modifying prompts won’t affect your APP or microservices +
+ + The API Service Plaza is one of APIPark’s core features, aiming to solve the problem of fragmented and chaotic internal API management in enterprises. Through the API Service Plaza, enterprises can showcase all API services on a unified platform, allowing different departments and teams to easily find and use the required API services. + + + The full API lifecycle management feature helps enterprises standardize the API management process, manage API traffic forwarding and load balancing, and oversee all API versions published externally. This improves API quality and maintainability, enabling efficient development and stable operation to support rapid business growth and innovation. +
+ Centrally manage and display all AI / REST APIs + + Cover the entire API lifecycle from design, release, operation, to deprecation +
+ + The API Service Plaza is one of APIPark’s core features, aiming to solve the problem of fragmented and chaotic internal API management in enterprises. Through the API Service Plaza, enterprises can showcase all API services on a unified platform, allowing different departments and teams to easily find and use the required API services. + + + The full API lifecycle management feature helps enterprises standardize the API management process, manage API traffic forwarding and load balancing, and oversee all API versions published externally. This improves API quality and maintainability, enabling efficient development and stable operation to support rapid business growth and innovation. +
-Manage multiple tenants to ensure data isolation and security - -API resources need to be applied for and approved before they can be called -
+ Manage multiple tenants, ensuring data isolation and security + + API resources require approval before usage +
+ + The multi-tenant management feature allows enterprises to manage multiple tenants on the same platform. Each tenant can have independent resources, users, and permission settings, ensuring data and operation isolation, improving resource utilization efficiency, and simplifying management. + + + APIPark provides a process approval feature for all API resources, preventing violations or unauthorized API usage. Callers must apply for API resources and wait for the service provider's approval before officially using the API. +
- -The multi tenant management function provides enterprises with the ability to manage multiple tenants on the same platform. Each tenant can have independent resource, user, and permission settings, ensuring the isolation of data and operations, and helping to improve resource utilization efficiency and management convenience. - - -APIPark provides a process approval function for all API resources to avoid violating regulations or bypassing the platform to call APIs. The caller needs to first apply for API resources and wait for the service provider's approval before officially calling the API. -
+ Use detailed call logs to trace API access at any time + + Comprehensive statistical reports* +
-Assist in troubleshooting API access at any given time through detailed call logs - -Rich statistical reports* -
- -The API call log function provides comprehensive logging capabilities for enterprises, detailing all relevant information of each API call. Through these logs, enterprises can quickly track and troubleshoot issues in API calls, ensuring stable system operation and data security. - - -By analyzing historical call data, APIPark can display the long-term call trends and performance changes of APIs, helping enterprises to conduct preventive maintenance before problems occur. -
+ + The API call log feature provides enterprises with comprehensive logging capabilities, recording all relevant information for each API call. These logs allow enterprises to quickly trace and troubleshoot API call issues, ensuring system stability and data security. + + + Through historical call data analysis, APIPark can display long-term API call trends and performance changes, helping enterprises perform preventative maintenance before problems arise. +
+
+ +# 🚀 Use Cases +## Simplify AI Integration Costs + - Connect to 100+ major models from all mainstream AI vendors, with standardized API calls requiring no additional adaptation work. + - Combine AI models and prompt templates to create new AI APIs, simplifying AI API development. + - Quickly share AI APIs within the team. + +## Enhance Operational Efficiency + - Quickly build an internal API developer portal. + - Efficiently manage and call APIs. + - Reduce complex system call relationships. + +## Ensure Compliance and Security + - Powerful service governance and compliance management features. + - Granular permission management for application calls. + - Ensure API call security and compliance, reducing enterprise risk. + +## Simplify System Troubleshooting + - Use monitoring and diagnostic tools to quickly identify and resolve issues. + - Reduce downtime and improve system stability. + +## Multi-Tenant Management and Flexible Subscription + - Supports multi-tenant management to meet different business unit needs. + - Flexible subscription and approval processes simplify API usage and management. + +## Improve API Observability + - Real-time monitoring and tracking of API usage. + - Fully understand data flow to enhance data usage transparency.
-# 🚩 Applicable scenarios -## Improve operational efficiency -- Quickly build an internal API portal. -- Efficient management and API calling. -- Reduce complex inter system call relationships. +# 🚩 Roadmap +We’ve set exciting goals for APIPark: enabling everyone to quickly create their own products and AI agents using AI and APIs! -## Ensure compliance and safety -- Powerful service governance and compliance management capabilities. -- Refine the management of application call permissions. -- Ensure the security and compliance of API calls to reduce enterprise risks. - -## Simplify system troubleshooting -- Utilize monitoring and fault diagnosis tools to quickly identify and solve problems. -- Reduce downtime and improve system stability. - -## Multi tenant management and flexible subscriptions -- Support multi tenant management to meet the needs of different business units. -- Flexible subscription and approval processes simplify the use and management of APIs. - -## Enhance API observability -- Real time monitoring and tracking of API usage. -- Fully grasp the flow of data and enhance the transparency of data usage. - -## Enhance the value of data assets -- Quantify and analyze API usage to better evaluate and enhance the value of data assets. -- Provide data support for decision-making. +To achieve this goal, we plan to add new features to APIPark, including: +1. Integrating with API marketplaces such as Postman, RapidAPI, APISpace, APILayer, etc. You can directly use APIs from various API marketplaces through APIPark and make them smarter using AI. +2. Integrating AI Agents such as Langchain, AgentGPT, Auto-GPT, Dify, and more, allowing AI Agents to access your internal or third-party APIs through APIPark to complete more complex tasks. +3. Intelligent API orchestration: APIPark will provide a unified API entry point and automatically orchestrate multiple APIs to fulfill your requests based on the API content.
-# 🚀 One click deployment -APIPark deployment is very simple, just one command line can deploy your API asset open platform in 5 minutes. - -``` -curl -sSO https://download.apipark.com/install/quick-start.sh ; bash quick-start.sh -``` +# 📕 Documentation +Visit [APIPark Documentation](https://docs.apipark.com/docs/install) for detailed installation guides, API references, and usage instructions.
-## 📕 file -Visit [APIPark Document]（ https://docs.apipark.com/docs/install ）Get detailed installation guides, API references, and usage instructions. +# 🧾 License +APIPark uses the Apache 2.0 License. For more details, please refer to the LICENSE file.
-## 🧾 licence -APIPark uses the Apache 2.0 license. For more details, please refer to the LICENSE document. - - -
- -## 💌 contact us -For enterprise level functionality and professional technical support, please contact pre-sales experts for personalized demonstrations, customized solutions, and pricing. +# 💌 Contact Us +For enterprise-level features and professional technical support, contact our pre-sales experts for personalized demos, customized solutions, and pricing. - Website: https://apipark.com - Email: dev@apipark.com
-Thank you for choosing APIPark, the next-generation API Open platform. +🙏 A big thanks to everyone who helped shape APIPark. We are thrilled to hear the community’s thoughts! Let’s make the world of APIs and AI stronger and more fun together. 🎉