stackbook

← 辞書(分野別)

§5

API設計

最終確認:2026年9月

外部公開API
REST+OpenAPI(スキーマファースト)
  • GraphQLクライアントが多様で取得項目の自由度が必要なとき
同一リポジトリ内のフロント⇔バック(TS同士)
  • Next.jsのServer Actions/Route HandlersNext.jsの中で完結し、別プロセスのAPIを持たないとき
  • tRPC既存のtRPC資産があるとき
サービス間通信
Connect(Protocol Buffers)
OpenAPIの記述・Lint
  • Spectral独自ルールを細かく書きたいとき
OpenAPIからTSクライアント生成
  • OrvalTanStack Queryのフックまで生成したいとき
APIドキュメントの公開
  • Redoc静的なHTML1枚で配布したいとき
Protocol Buffersの管理
GraphQL(採用時)
TS:GraphQL Yoga+Pothos、Go:gqlgen
API手動テスト
Bruno(コレクションをGitで管理できる)
  • Postmanチームが既に使っているとき
Webhook受信の開発