首页
/ APIClarity 开源项目教程

APIClarity 开源项目教程

2024-09-21 10:10:57作者:明树来

1. 项目介绍

APIClarity 是一个开源的 API 安全工具,旨在捕获和分析 API 流量,测试 API 端点,重建 OpenAPI 规范,并识别 API 安全风险。它作为一个 pod 部署在 Kubernetes 集群中,通过分析 API 流量来发现潜在的安全风险。APIClarity 的主要功能包括自动重建 OpenAPI 规范、检测影子 API 和僵尸 API、检测 Broken Function-Level Authorization (BFLA) 等。

2. 项目快速启动

2.1 安装 Helm 仓库

首先,添加 APIClarity 的 Helm 仓库:

helm repo add apiclarity https://openclarity.github.io/apiclarity

2.2 保存默认的 Helm 值

保存 APIClarity 的默认 Helm 值到 values.yaml 文件中:

helm show values apiclarity/apiclarity > values.yaml

2.3 更新 values.yaml 文件

根据你的需求更新 values.yaml 文件,配置所需的流量源。

2.4 使用 Helm 安装 APIClarity

使用 Helm 安装 APIClarity:

helm install --values values.yaml --create-namespace apiclarity apiclarity/apiclarity -n apiclarity

2.5 端口转发

进行端口转发以访问 APIClarity UI:

kubectl port-forward -n apiclarity svc/apiclarity-apiclarity 9999:8080

2.6 访问 APIClarity UI

打开浏览器访问 APIClarity UI:

http://localhost:9999/

3. 应用案例和最佳实践

3.1 案例一:使用 APIClarity 监控 Istio 服务网格

假设你已经在 Kubernetes 集群中安装了 Istio 服务网格,并希望使用 APIClarity 来监控 API 流量。你可以按照以下步骤进行配置:

  1. 确保 Istio 1.10+ 已安装并运行在你的集群中。
  2. 按照快速启动中的步骤安装 APIClarity。
  3. values.yaml 文件中启用 Istio 服务网格的流量源。

3.2 案例二:使用 APIClarity 监控 Kong API 网关

如果你使用 Kong API 网关来管理你的 API,你可以使用 APIClarity 来监控通过 Kong 的 API 流量。配置步骤如下:

  1. values.yaml 文件中启用 Kong 流量源。
  2. 运行安装命令并配置 Kong 插件。

4. 典型生态项目

4.1 Istio

Istio 是一个开源的服务网格,APIClarity 可以与 Istio 集成,通过安装 WebAssembly (WASM) 过滤器来捕获内部 API 流量。

4.2 Kong API 网关

Kong API 网关是一个流行的开源 API 网关,APIClarity 可以通过插件与 Kong 集成,监控通过 Kong 的 API 流量。

4.3 OpenTelemetry

OpenTelemetry 是一个开源的观测框架,APIClarity 可以通过 OpenTelemetry 收集器来接收外部 API 流量,并进行分析。

通过这些集成,APIClarity 可以提供全面的 API 安全监控和分析能力。

热门项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
610
115
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
286
79
mdmd
✍ WeChat Markdown Editor | 一款高度简洁的微信 Markdown 编辑器:支持 Markdown 语法、色盘取色、多图上传、一键下载文档、自定义 CSS 样式、一键重置等特性
Vue
111
25
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
48
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
29
go-stockgo-stock
🦄🦄🦄AI赋能股票分析:自选股行情获取,成本盈亏展示,涨跌报警推送,市场整体/个股情绪分析,K线技术指标分析等。数据全部保留在本地。支持DeepSeek,OpenAI, Ollama,LMStudio,AnythingLLM,硅基流动,火山方舟,阿里云百炼等平台或模型。
Go
1
0
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
57
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
376
36
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
182
44
frogfrog
这是一个人工生命试验项目,最终目标是创建“有自我意识表现”的模拟生命体。
Java
8
0