OpenAPI とその他の言語

API 全体は OpenAPI 3.1 のドキュメントで記述されています。これはこのサイトの API リファレンスの元になっており、公式 SDK のない言語向けにクライアントを生成することもできます。

• 仕様: https://api.spacepost.dev/openapi.json
• リポジトリ内のソースファイル: openapi/openapi.yaml

クライアントを生成する

ベース URL を https://api.spacepost.dev に設定し、sp_live_ キーでベアラー認証を構成します。

TypeScript

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>" },
});

Python

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

Go

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 など、数十の言語向けのジェネレーターがあります。

ヒント

生成されたクライアントは、エラーが共通の形式であることや Idempotency-Key について知りません。必要な場合は、そのヘッダーをクライアントの既定のヘッダー、またはリクエストごとのヘッダーに追加し、エラーは { statusCode, name, message } としてパースしてください。

Postman と API ツール

仕様の URL を Postman、Insomnia、Bruno、Hoppscotch にインポートします。ベアラートークン用に、コレクション変数を設定してください。

Resend の SDK を使う

SpacePost は Resend と互換性があるため、他の言語の公式 Resend SDK も、ベース URL を上書きするだけで動作することがよくあります。Resend からの移行をご覧ください。

API リファレンスすべてのエンドポイントと、リクエスト・レスポンスのスキーマ。