OpenAPI e altri linguaggi

L’intera API è descritta da un documento OpenAPI 3.1. Alimenta il riferimento API di questo sito e può generare client per i linguaggi privi di un SDK ufficiale.

• Specifica: https://api.spacepost.dev/openapi.json
• File sorgente nel repository: openapi/openapi.yaml

Generare un client

Imposta l’URL di base su https://api.spacepost.dev e configura l’autenticazione bearer con la tua chiave sp_live_.

TypeScript

Tipi e un client fetch con openapi-typescript e openapi-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

Qualsiasi linguaggio

Usa OpenAPI Generator:

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

Esistono generatori per PHP, Ruby, Java, Kotlin, Swift, C#, Rust e decine di altri.

Consiglio

I client generati non sanno che gli errori hanno tutti la stessa forma, né conoscono Idempotency-Key. Aggiungi quell’header agli header predefiniti o per singola richiesta del tuo client dove ti serve, e analizza gli errori come { statusCode, name, message }.

Postman e strumenti per API

Importa l’URL della specifica in Postman, Insomnia, Bruno o Hoppscotch. Imposta una variabile di collezione per il bearer token.

Usare gli SDK di Resend

Poiché SpacePost è compatibile con Resend, gli SDK ufficiali di Resend in altri linguaggi spesso funzionano sovrascrivendo il loro URL di base. Vedi Migrare da Resend.

Riferimento APIOgni endpoint con gli schemi di richiesta e risposta.