📄️ 添加服务分类
为API设置可选择的分类标签,便于团队成员在API市场中快速查找和使用所需的API。
📄️ 添加服务
作为服务提供方,首先需要在平台上添加新的服务。在添加服务时,填写服务名称、描述等必要信息。服务名称应该简洁明了,描述应包含服务的主要功能和用途。
📄️ 配置上游
“上游”是指 API 请求最终被路由到的后端服务器或服务。上游通常包含 处理 API 请求的实际业务逻辑、数据存储和应用程序。在 API 网关架构中,网关接收并处理来自客户端的请求,然后将这些请求转发到上游服务器进行具体处理,获取响应并返回给客户端。
📄️ 添加路由
路由是指API网关根据客户端请求的特定路径或条件,将请求转发到相应的后端服务的过程。API网关是一个位于客户端和服务器之间的中间层,用于管理、监控和路由客户端的API请求。它的路由功能是API网关的核心功能之一。
📄️ 配置API(OpenAPI)
OpenAPI 是一个广泛使用的规范,用于描述和文档化 RESTful API。最初被称为 Swagger,OpenAPI 规范(OpenAPI Specification, OAS)提供了一种 结构化的方式来定义 API 的接口,包括它的端点、操作、请求、响应以及其他相关的元数据。OpenAPI 旨在使 API 的设计、开发、文档生成和测试变得更简单、更一致。
📄️ 配置服务使用文档
为了方便订阅方理解和使用API,服务提供方需要配置详细的服务使用说明。清晰的使用说明可以帮助订阅方快速上手,减少使用过 程中遇到的问题。
📄️ 发布版本
发布服务版本是将最新配置的服务和 API 部署到生产环境的重要步骤,确保订阅者调用时可以访问到最新发布版本的 API。通过发布服务版本,可以统一管理 API 和服务的生命周期,确保服务和 API 的最新配置能够及时生效,保证系统的稳定性和可靠性。
📄️ 订阅审批
审批订阅是指在 APIPark中,服务提供方对订阅者申请的 API 服务订阅请求进行审核和批准的过程。通过这一过程,平台可以确保只有授权的用户能够访问特定的 API 服务,保障系统的安全性和服务质量。