data class OpenApiDocument(val openapi: String = "3.1.0", val info: Info, val servers: List<Server> = emptyList(), val paths: Map<String, PathItem> = emptyMap(), val components: Components? = null, val security: List<Map<String, List<String>>>? = null, val tags: List<Tag>? = null)

OpenAPI 3.1.0ドキュメントのルートオブジェクト

Operation

@Serializable

data class Operation(val summary: String? = null, val description: String? = null, val operationId: String? = null, val tags: List<String>? = null, val parameters: List<Parameter>? = null, val requestBody: RequestBody? = null, val responses: Map<String, Response>, val security: List<Map<String, List<String>>>? = null)

オペレーション HTTPメソッドに対応する操作を定義する

Parameter

@Serializable

data class Parameter(val name: String, val location: String, val description: String? = null, val required: Boolean = false, val schema: Schema? = null)

パラメータリクエストパラメータ（path, query, header, cookie）を定義する

PathItem

@Serializable

data class PathItem(val summary: String? = null, val description: String? = null, val get: Operation? = null, val post: Operation? = null, val put: Operation? = null, val delete: Operation? = null, val patch: Operation? = null)

パスアイテム特定のパスに対する操作を定義する

RequestBody

@Serializable

data class RequestBody(val description: String? = null, val content: Map<String, MediaType>, val required: Boolean = false)

リクエストボディ

Response

@Serializable

data class Response(val description: String, val content: Map<String, MediaType>? = null)

レスポンス

Schema

@Serializable

data class Schema(val type: String? = null, val format: String? = null, val description: String? = null, val properties: Map<String, Schema>? = null, val items: Schema? = null, val required: List<String>? = null, val additionalProperties: Boolean? = null, val nullable: Boolean? = null, val enum: List<String>? = null)

JSONスキーマデータ構造を定義する

SecurityScheme

@Serializable

data class SecurityScheme(val type: String, val description: String? = null, val flows: OAuthFlows? = null)

セキュリティスキーム

Server

@Serializable

data class Server(val url: String, val description: String? = null)

サーバー情報

Tag

@Serializable

data class Tag(val name: String, val description: String? = null)

タグ情報エンドポイントをグループ化するために使用