oasis-genOpenAPI 3.2 向けの最小限の API クライアント生成ツール

出力は依存関係のない TypeScript ファイル 1 つで、すべての操作の型と fetch ベースの小さなランタイムを含みます。

OpenAPI 3.2
QUERY 操作、逐次的なメディアタイプ（sequential media types）、複数のファイルに分割した OpenAPI ドキュメント、JSON Schema 2020-12 に対応しています。また、oasis-gen は OpenAPI 3.0 と 3.1 のドキュメントも受け付けます。
厳密な型
status によって data は宣言されたレスポンスの型に絞り込まれます。ドキュメントで宣言されていないステータスも型に残ります。また、リクエストの型には readOnly と writeOnly が反映されます。
実行時の依存関係ゼロ
出力は 1 つの TypeScript ファイルで、fetch を使用できる環境ならどこでも動作します。インストールするランタイムパッケージも、設定する項目もありません。

例

sh

npx oasis-gen openapi.yaml -o src/api.ts

ts

import { createClient
 } from "./api.ts";

const api
 = createClient
({ baseUrl
: "https://api.example.com" });

const res
 = await api
.GET
("/pets/{petId}", { path
: { petId
: 1 } });
if (res
.status
 === 200) {
  res
.data
.name
; // 200 のレスポンスから型付けされる
} else if (res
.status
 === 404) {
  res
.data
.title
; // 404 のレスポンスから型付けされる
}