Open API

commited date: 2024-12-21

HTTP APIの動作を記述するためのオープンで標準的な仕様。リクエストからレスポンスまでAPIのライフサイクルを説明できる

JSONまたはYAMLでコード管理が可能

Swaggerのようなツール群ではOpen API仕様をベースにドキュメンテーションやテストを用意に実装できる

gRPC-Gateway

#Network #API Architecture #REST gRPCにおいて、gRPC serviceをRESTful APIとして提供するためのライブラリ。HTTP+JSONのインターフェースでリバースプロキシサーバーを生成する HTTP仕様はProtocol Buffers上において google.api.http のような HttpRule によって記述する同リポジトリにはprotoc-gen-openapiv2プラグインも含まれておりOpen API仕様を出力できる gRPC-Gateway | gRPC-Gateway Documentation Website

Redoc

#Documentation Open API仕様を元にドキュメンテーションを行いシンプルなUIで表示される CLIによるドキュメント生成またはHTMLファイルへのscript埋込が可能 Redoc

マスタリングAPIアーキテクチャ

Swagger