https://engine.speedle.io/zh/tags/api/ Recent content in Api on Speedle Hugo -- gohugo.io zh-cn Fri, 18 Jan 2019 21:19:44 +0800 https://engine.speedle.io/zh/docs/api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/ Java、Python、Go、.NET、Rust 和 Node.js/TypeScript 的客户端库见 SDK。 REST API 这些接口说明面向你配置的 PMS、ADS 或断言服务端点。speedle.io 提供文档与浏览器 Playground，不托管 PMS/ADS 后端。发送 JSON 时必须设置 Content-Type: application/json，并配置 TLS/mTLS 与调用方访问控制。 策略管理 API 授权决策 API 令牌断言 webhook 策略和角色策略的 ID 是字符串，PMS 返回扁平对象；授权权限字段为复数 permissions。REST 决策请求使用带类型的属性数组，诊断响应及断言 webhook 的属性则为对象。 gRPC API PMS proto：pb.PolicyManager ADS proto：pb.Evaluator 当前 proto 必须与生成客户端配套使用。PMS 的服务名为 pb.PolicyManager，ADS 为 pb.Evaluator。这两份历史协议重用了消息名，应分别生成和加载，不要合并进同一 descriptor set。默认不启用 gRPC；需通过 --grpc-endpoint 显式开启，其 TLS 配置与 REST 相同。 历史 gRPC 的 ContextRequest.attributes 是字符串 map，不是 REST 的带类型属性数组，也不提供同样的数值、布尔、日期类型。条件需要这些类型时，应使用 REST 或嵌入式 Go，除非你的 gRPC 适配层明确实现了相应转换。 https://engine.speedle.io/zh/docs/api/decision_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/decision_api/ 已配置 ADS 的接口参考。请求属性是带类型的数组，诊断响应属性是对象。 请配置安全连接与端点访问控制。这是接口契约，speedle.io 不托管授权后端。 (function() { var url = "\/swagger\/policy-check.zh.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], validatorUrl: null, layout: "BaseLayout" }) window.ui = ui })(); https://engine.speedle.io/zh/docs/sdks/dotnet/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/sdks/dotnet/ .NET SDK 面向 .NET 8 或更高版本，没有依赖。软件包：NuGet 上的 Speedle.Sdk 0.1.0，命名空间 Speedle.Sdk。参考文档：speedle-sdk/dotnet。 示例检查的策略见 SDK 概览。 添加依赖 新建控制台项目并添加软件包： dotnet new console -o SpeedleExample cd SpeedleExample dotnet add package Speedle.Sdk --version 0.1.0 调用本地 Speedle 按 SDK 概览中的说明启动 Speedle 并创建示例策略。将 Program.cs 替换为： using Speedle.Sdk; try { await using var speedle = new SpeedleClient(new SpeedleClientOptions { Backend = Backend.SpeedlePlus, Endpoint = new Uri("http://localhost:6734"), Auth = Auth.None(), ServiceName = "docs", }); bool allowed = await speedle.IsAllowedAsync("alice", "get", "/docs/public"); Console. https://engine.speedle.io/zh/docs/sdks/go/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/sdks/go/ Go SDK 支持最新的两个 Go 版本，只使用标准库。模块：github.com/teramoby/speedle-sdk/go v0.1.0，包名 speedle。参考文档：speedle-sdk/go。 示例检查的策略见 SDK 概览。 添加依赖 在新模块中执行： go mod init example.com/speedle-example go get github.com/teramoby/speedle-sdk/go@v0.1.0 调用本地 Speedle 按 SDK 概览中的说明启动 Speedle 并创建示例策略。将以下程序保存为 main.go： package main import ( "context" "fmt" "os" speedle "github.com/teramoby/speedle-sdk/go" ) func main() { client, err := speedle.NewClient(speedle.Config{ Backend: speedle.BackendSpeedlePlus, Endpoint: "http://localhost:6734", Auth: speedle.NoAuth(), ServiceName: "docs", }) if err != nil { fmt.Fprintln(os.Stderr, "Speedle error:", err) os.Exit(1) } defer client.Close() ctx := context.Background() allowed, err := client. https://engine.speedle.io/zh/docs/sdks/java/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/sdks/java/ Java SDK 需要 Java 17 或更高版本，没有运行时依赖。软件包：Maven Central 上的 io.speedle:speedle-sdk 0.1.0。参考文档：speedle-sdk/java。 示例检查的策略见 SDK 概览。 添加依赖 Maven，完整的 pom.xml： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.example</groupId> <artifactId>speedle-example</artifactId> <version>1.0</version> <properties> <maven.compiler.release>17</maven.compiler.release> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> <dependencies> <dependency> <groupId>io.speedle</groupId> <artifactId>speedle-sdk</artifactId> <version>0.1.0</version> </dependency> </dependencies> </project> Gradle，完整的 build.gradle.kts（另需一个设置 rootProject.name 的 settings.gradle.kts）： plugins { application } repositories { mavenCentral() } dependencies { implementation("io.speedle:speedle-sdk:0.1.0") } application { mainClass = "Main" } 调用本地 Speedle 按 SDK 概览中的说明启动 Speedle 并创建示例策略。将以下程序保存为 src/main/java/Main. https://engine.speedle.io/zh/docs/sdks/node/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/sdks/node/ Node.js SDK 需要 Node.js 22 或更高版本，同时提供 ESM 和 CommonJS 构建及 TypeScript 类型，没有运行时依赖。软件包：npm 上的 @speedle/sdk 0.1.0，发布后可用。参考文档：speedle-sdk/node。 示例检查的策略见 SDK 概览。 添加依赖 新建 ES 模块包并安装（发布后可用）： mkdir speedle-example cd speedle-example npm init -y npm pkg set type=module npm install @speedle/sdk@0.1.0 调用本地 Speedle 按 SDK 概览中的说明启动 Speedle 并创建示例策略。将以下程序保存为 main.ts： import { Auth, Reason, SpeedleClient, SpeedleError } from "@speedle/sdk"; try { const speedle = new SpeedleClient({ backend: "speedle-plus", endpoint: "http://localhost:6734", auth: Auth.none(), serviceName: "docs", }); try { const allowed = await speedle. https://engine.speedle.io/zh/docs/api/management_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/management_api/ 已配置 PMS 的接口参考。请求与响应使用 JSON，策略 ID 为字符串，响应为扁平对象。 请配置安全连接与端点访问控制。这是接口契约，speedle.io 不托管授权后端。 (function() { var url = "\/swagger\/policy-manage.zh.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], validatorUrl: null, layout: "BaseLayout" }) window.ui = ui })(); https://engine.speedle.io/zh/docs/sdks/python/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/sdks/python/ Python SDK 需要 Python 3.10 或更高版本，唯一的运行时依赖是 httpx。它提供同步的 Client 和 asyncio 的 AsyncClient，两者参数相同。软件包：PyPI 上的 speedle 0.1.0。参考文档：speedle-sdk/python。 示例检查的策略见 SDK 概览。 添加依赖 使用 pip，在虚拟环境中安装： python3 -m venv .venv . .venv/bin/activate pip install speedle==0.1.0 或者使用 uv，在 uv 项目中添加： uv add speedle==0.1.0 调用本地 Speedle 按 SDK 概览中的说明启动 Speedle 并创建示例策略。将以下程序保存为 main.py： import sys from speedle import Auth, Client, SpeedleError try: with Client( backend="speedle-plus", endpoint="http://localhost:6734", auth=Auth.none(), service_name="docs", ) as speedle: allowed = speedle.is_allowed("alice", "get", "/docs/public") print(f"alice get /docs/public: allowed={allowed}") decision = speedle. https://engine.speedle.io/zh/docs/sdks/rust/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/sdks/rust/ Rust SDK 需要 Rust 1.75 或更高版本，基于 tokio 和 reqwest（rustls）实现异步调用；下面使用的阻塞客户端由 blocking 特性提供。crate：crates.io 上的 speedle 0.1.0。参考文档：speedle-sdk/rust。 示例检查的策略见 SDK 概览。 添加依赖 新建包并添加依赖： cargo new speedle-example cd speedle-example cargo add speedle@0.1.0 --features blocking 调用本地 Speedle 按 SDK 概览中的说明启动 Speedle 并创建示例策略。将 src/main.rs 替换为： use speedle::blocking::Client; use speedle::{Auth, Backend}; fn main() { if let Err(e) = run() { eprintln!("Speedle error: {e}"); std::process::exit(1); } } fn run() -> Result<(), speedle::Error> { let speedle = Client::builder(Backend::SpeedlePlus, "http://localhost:6734", Auth::none(), "docs"). https://engine.speedle.io/zh/docs/pms/ Fri, 18 Jan 2019 21:19:44 +0800 https://engine.speedle.io/zh/docs/pms/ Policy Management Global Policy Policy Discovery Policy Diagnosis https://engine.speedle.io/zh/docs/api/asserter_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/asserter_api/ 令牌断言 webhook 参考。errCode 为整数，attributes 为对象。实际端点由 ADS 断言配置指定。 请配置安全连接与端点访问控制。这是接口契约，speedle.io 不托管授权后端。 (function() { var url = "\/swagger\/asserter.zh.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], validatorUrl: null, layout: "BaseLayout" }) window.ui = ui })();