完成一版 Option定义

define/openapi.go

@@ -15,7 +15,7 @@ package define
 type OpenapiDoc struct {
 	Openapi string                                `json:"openapi" required:"true"` // 必选. 这个字符串必须是开放 API 规范版本号提到的符合语义化版本号规范的版本号。openapi字段应该被工具或者客户端用来解释 OpenAPI 文档.
 	Info    *Info                                 `json:"info" required:"true"`    // 必选。此字段提供 API 相关的元数据。相关工具可能需要这个字段。
-	Servers []any                                 `json:"servers"`                 // 服务环境
+	Servers []*ServerItem                         `json:"servers"`                 // 服务环境
 	Tags    []TagItem                             `json:"tags"`                    // 全部标签列表
 	Paths   map[string]map[string]*PathItemConfig `json:"paths"`                   // 接口路径 -> 接口请求方法 -> 具体配置
 }
@@ -58,6 +58,11 @@ type PathItemOperationConfig struct {
 	OperationID  string                 `json:"operationId"`  // 用于标识此操作的唯一字符串，这个id在此API内包含的所有操作中必须是唯一的。相关的工具和库可能会使用此operationId来唯一的标识一个操作，因此推荐在命名时符合一般的编程命名习惯
 	Parameters   []*PathConfigParameter `json:"parameters"`   // 定义可用于此操作的参数列表，如果一个同名的参数已经存在于 Path Item，那么这里的定义会覆盖它但是不能移除上面的定义。这个列表不允许包含重复的参数，参数的唯一性由 name 和 location 的组合来确定。这个列表可以使用 Reference 对象 来连接定义于 OpenAPI 对象 components/parameters 的参数。
 	RequestBody  *RequestBody           `json:"requestBody"`  // 可用于此操作的请求体。requestBody 只能被用于HTTP 1.1 规范 RFC7231 中明确定义了包含请求体的请求方法，在其他没有明确定义的请求方法中，requestBody的消费者应该应该忽略requestBody。
+	Responses    map[string]*Response   `json:"responses"`    // 描述一个操作可能发生的响应的响应码与响应包含的响应体的对象。default字段可以用来标记一个响应适用于其他未被规范明确定义的HTTP响应码的默认响应。一个Responses 对象必须至少包含一个响应码，而且是成功的响应。
+	Callbacks    map[string]any         `json:"callbacks"`    // 一组相对于父操作的可能出现的回调映射，映射中的每一个键都唯一的映射一个 Callback 对象
+	Deprecated   bool                   `json:"deprecated"`   // 声明此操作已经被废弃，使用者应该尽量避免使用此操作，默认的值是 false。
+	Security     any                    `json:"security"`     // 声明那种安全机制可用于此操作。这个列表可以包含多种可用于此操作的安全需求对象，但是在认证一个请求时应该仅使用其中一种。这里的定义会覆盖任何在顶层 security 中的安全声明，因此可以声明一个空数组来变相的移除顶层的安全声明。
+	Servers      []*ServerItem          `json:"servers"`      // 一个可用于此操作的额外的 server 数组，这里的定义会覆盖 Path Item 对象 或 顶层的定义。
 }
 
 // ExternalDocs 外部文档配置
@@ -215,6 +220,18 @@ type Example struct {
 	ExternalValue string `json:"externalValue"` // 指向字面 example 的一个 URL。这提供了引用无法被包含在 JSON 或 YAML 文档中的 example。value 字段和 externalValue 字段是互斥的。
 }
 
+// Response 响应的数据结构
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 17:38 2024/7/19
+type Response struct {
+	Description string             `json:"description"` // 必选. 对响应的简短描述。CommonMark syntax可以被用来呈现富文本格式.
+	Headers     map[string]*Header `json:"headers"`     // 映射HTTP头名称到其定义。RFC7230 规定了HTTP头名称不区分大小写。如果一个响应头使用"Content-Type"作为HTTP头名称，它会被忽略。
+	Content     map[string]*Media  `json:"content"`     // 一个包含描述预期响应负载的映射。使用 media type 或 media type range 作为键，以响应的描述作为值。当一个响应匹配多个键时，只有最明确的键才适用。比如：text/plain 会覆盖 text/*
+	Ref         string             `json:"$ref"`        // 引用描述
+}
+
 // Info 信息
 //
 // Author : go_developer@163.com<白茶清欢>