OpenAPI 与其他语言

完整的 API 由一份 OpenAPI 3.1 文档描述。本站的 API 参考就是由它生成的，它还可以为没有官方 SDK 的语言生成客户端。

规范：https://api.spacepost.dev/openapi.json
仓库中的源文件：openapi/openapi.yaml

生成客户端

将基础 URL 设置为 https://api.spacepost.dev，并使用你的 sp_live_ 密钥配置 bearer 身份验证。

使用 openapi-typescript 和 openapi-fetch 生成类型和 fetch 客户端：

npx openapi-typescript https://api.spacepost.dev/openapi.json -o spacepost.d.ts
npm install openapi-fetch

import createClient from "openapi-fetch";
import type { paths } from "./spacepost";

const client = createClient<paths>({
  baseUrl: "https://api.spacepost.dev",
  headers: { Authorization: `Bearer ${process.env.SPACEPOST_API_KEY}` },
});

const { data, error } = await client.POST("/emails", {
  body: { from: "Acme <hello@acme.com>", to: ["user@example.com"], subject: "Hi", html: "<p>Hi</p>" },
});

pipx install openapi-python-client
openapi-python-client generate --url https://api.spacepost.dev/openapi.json

go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest
curl -s https://api.spacepost.dev/openapi.json -o openapi.json
oapi-codegen -package spacepost -generate types,client openapi.json > spacepost.gen.go

使用 OpenAPI Generator：

npx @openapitools/openapi-generator-cli generate \
  -i https://api.spacepost.dev/openapi.json \
  -g ruby -o ./spacepost-ruby

PHP、Ruby、Java、Kotlin、Swift、C#、Rust 等数十种语言都有对应的生成器。

Postman 与 API 工具

将规范的 URL 导入 Postman、Insomnia、Bruno 或 Hoppscotch。为 bearer 令牌设置一个集合变量。

使用 Resend SDK

由于 SpacePost 兼容 Resend，其他语言的官方 Resend SDK 通常只需覆盖基础 URL 即可使用。参见从 Resend 迁移。

API 参考所有端点及其请求和响应结构。