コード日進月歩

しんくうの技術的な小話、メモ、つれづれ、など

OpenAPI3.0で使うcomponentsの種類をざっくりまとめる

Swaggerと呼ばれたりOpenAPIと呼ばれたりするOpenAPI Specification。どれが何やねん、ってなるのでメモ。

環境

openapi: 3.0.0

componentsセクションの種類

記述名 用途
schema 具体的なオブジェクト
parameters APIのパラメータ、クエリストリングやパスパラメータはこちら
securitySchemes 認証系などの情報、Basic認証などを記述
requestBodies 文字通りリクエストボディ、POSTリクエストの内容などを記述
responses レスポンス、返却値を記載。主にJSONの内容を記述する
headers APIのリクエストヘッダなどを記述
example 公式ドキュメントに記述がないのでよくわからないが、おそらくschemaなどのexampleをまとめるためのもの
links 使い回すlinks のパラメータを保持
callbacks 使い回すcallbacksの情報を保持

参考リンク