Learn VisualLearn API

1つのスキーマから、ドキュメントとSDKを生成する

OpenAPIは、APIのエンドポイント、リクエストとレスポンスの形、ステータスコードを、特定の実装から独立したスキーマ文書として記述します。

契約ファーストの開発では、実装より先に、そのスキーマを書きます。開発者が実際のコードをまだ書いている間でも、クライアント側とサーバー側のチームは、合意した形に沿って作業できます。これは、実装を先に作り、そのあとで挙動を説明するためにスキーマを書く、という順序とは逆です。

ツールは、この1つのスキーマから、対話的なドキュメント、複数言語のクライアントSDK、リクエストとレスポンスの検証を生成できます。これらはすべて、同じスキーマから生成するため、互いに一致し続けます。ドキュメントや検証ロジックが、実際の挙動から時間とともにずれていくことがありません。

この課の目標

契約ファーストの開発が何を意味するか説明できる。OpenAPIのスキーマから自動的に何が生成できるか説明できる。

あるチームがOpenAPIスキーマのあるフィールドの型を変更した。生成されたドキュメントとクライアントSDKはどうなる?