跳到主要内容

60 篇文档带有标签「API7 Enterprise」

查看所有标签

API 限流限速

本文将指导你如何在 API7 控制台中使用 limit-count 插件对 API 进行限流限速配置,以及如何验证结果。

Certificate Management

Dashboard has built-in SSL certificate management system, which can manage SSL certificates in the cluster manually or by uploading files.

Consumer Management

Dashboard has built-in consumer module, which refers to the consumer of a certain type of service and can only be used with the user authentication system.

Docker 部署

本指南将指引你将 API7 Enterprise 的所有必要组件快速部署到同一台机器上,以便进行 PoC 功能验证。部署完成后,这台机器的地址就是 API7 Gateway address.

FAQ

Frequently Asked Questions

Gateway Nodes

Dashboard built-in gateway node module, so that users can view API7 node information.

Integrate with Apache SkyWalking

Apache SkyWalking is an application performance monitor and observability analysis platform for distributed systems. It provides multi-dimensional application performance analysis methods and alarm features from call chain tracing to associative log analysis. At the same time, it is also one of the most popular applications performance monitor systems.

LDAP

Authentication using LDAP (DKEY)

Management of resources

More and more enterprises will run multiple API7 clusters and etcd clusters internally, and the API7 Dashboard supports the ability to visually configure gateways in the case of multiple clusters.

Monitoring Reports

You can quickly understand the routing situation under the current cluster on the monitoring page, which includes the following indicators:

Overview

API7 Dashboard is a browser-based visual platform for monitoring and managing API7.

Platform Architecture

API7 Dashboard is based on the Apache APISIX Dashboard and maintains the same platform architecture.

Role Management

RBAC is a role-based resource access control mechanism. The API7 Dashboard controls the permissions that users can access resources by assigning roles to different users.

User Login

Access the dashboard URL through the browser, the login page will be displayed when you are not logged in. After entering the account and password, click the login button to log in.

User Management

Dashboard supports user management system for managing internal staff information.

使用 Prometheus 和 Grafana 监控 API 及网关

为了让 Web 应用程序跨不同的源发出请求(即向不同于请求页面的方案、主机名或端口的 URL 发出请求),实现了一组名为跨源资源共享 (CORS) 的规则。每当进行跨源请求时,浏览器都会发送一个 Origin 请求头,服务器必须以匹配的 Access-Control-Allow-Origin (ACAO) 响应头进行响应。如果这两个头不匹配,浏览器将拒绝响应,导致任何依赖于该数据的应用程序组件失效。

发布 API 到 API7 网关

API 开发完毕后,需要发布到 API7 网关中,以获得 API7 带来的各种强大能力。本文将指导你如何在 API7 控制台中发布一个 API,以及如何验证发布结果。

发布 API 到开发者门户

本文将指导你作为 API 的生产者及管理员,如何将已经接入 API7 网关的 API 发布到与网关配套的开发者门户,允许内部或外部的开发者登录后查找到这个 API,查看都已经的 API 文档,并申请订阅 API,获得 API 管理员的同意后,自动获取访问凭证。

发布管理

灰度发布又名金丝雀发布,是指在稳定的生产环境之外,额外部署一个小规模的灰度集群,通过控制流量的方式将部分流量在灰度集群进行验证。如果验证失败,可以立即将所有流量切换到稳定集群中;如果验证无异常,可以将流量全量发布到新的集群中,完成灰度发布任务。

告警历史

需要先安装 Prometheus,AlertManager,OpenSearch 几个组件。

处理 API 跨域问题

为了让 Web 应用程序跨不同的源发出请求(即向不同于请求页面的方案、主机名或端口的 URL 发出请求),实现了一组名为跨源资源共享 (CORS) 的规则。每当进行跨源请求时,浏览器都会发送一个 Origin 请求头,服务器必须以匹配的 Access-Control-Allow-Origin (ACAO) 响应头进行响应。如果这两个头不匹配,浏览器将拒绝响应,导致任何依赖于该数据的应用程序组件失效。

开发 API

本文将指导你作为 API 的生产者及管理员,如何根据已经完成的 API 设计文档来开发出性能健康的 API。

开发者

仅在业务开放平台不具备可用的账号体系时,才启用开发者门户自带的开发者模块,提供最基础的邮箱登录方式,并将开发者账户数据保存在开发者门户中。

开启 API 身份认证

身份认证是 API 基础需求之一,在 API7 Enterprise 中支持非常丰富的身份认证方式,例如:key-auth、basic-auth、ldap-auth 等等,本指南中将会以 key-auth 插件为例介绍如何为 API 增加身份认证能力。

搭建开发者门户站点

本文将指导你作为 API 的生产者及管理员,如何将已经接入 API7 网关的 API 发布到与网关配套的开发者门户,搭建一个站点,允许内部或外部的开发者登录后查找到这个 API,查看对应的 API 文档,并申请订阅 API,获得 API 管理员的同意后,自动获取访问凭证。

概览

什么是 API7 Enterprise

概览

什么是 API7 Enterprise

概览

当今计算机世界,人们早已习惯使用 API 在软件之间完成信息的交换,不论是你在手机上查看天气信息、查看微信朋友圈的动态、亦或是和 ChatGPT 交互,其实都是通过 API 来完成的。从定义上来说,API 是一组通信的约定,它规定了你(或者软件)如何与目标软件服务交互。

获取许可证

在安装 API7 Enterprise 后,你需要获取许可证并在控制台中上传激活。

设置

编辑开发者门户地址

设计 API

作为工程师,我们总是强调在编码前先进行方案的设计。API 也不例外,我们需要根据业务明确一个 API 的功能目的,

通过开发者门户订阅 API

本文将指导你作为一个开发者,如何登录开发者门户,申请订阅 API 以获取访问凭证,并成功调用 API。

阻止特定 IP 访问 API

在本文中,我们将探讨如何使用 API7 Enterprise 平台实现 API 的 IP 限制功能。通过这个功能,我们可以实现阻止或者允许 IP 地址访问 API。

高可用

本文将指导你如何部署具备高可用性的 API7 Enterprise。我们将以构建一个最小可用的高可用性架构为例进行演示,包括数据面(Data Plane)的高可用、控制面(Control Plane)的高可用和etcd集群的高可用。