为了方便重用,requestBody的内容也可以放到components对象的requestBodies中: # 对所提供的 API 有效的路径和操作paths:/pet:post:tags:-petsummary:向商店中添加新的宠物operationId:addPetresponses:'405':description:非法的操作requestBody:# 请求体$ref:'#/components/requestBodies/Pet'components:schemas:Category:t...
组件集合对象(Components Object) 在OpenAPI 中,组件集合对象包含了所有可重用的对象的定义。在 API 文档的其他部分,可以对这些组件对象进行引用。组件集合对象位于 OpenAPI 根对象下,在 API 文档中,使用 components 字段表示。 使用组件对象替代重复使用的内容描述,不仅可以提升效率,还能缩减文档的大小,增强文档的可维护...
一种自包含或复合资源,用于定义或描述API或API元素。OpenAPI文档必须至少包含一个paths 字段,一个components字段或一个webhooks字段。OpenAPI文档使用并符合OpenAPI规范。 Path模板 Path模板是指使用大括号({})包围的模板表达式,用来在URL路径中标记一个可以被path参数替换的部分。 路径中每个模板表达式必须对应于一个path...
代码语言:javascript 复制 paths: /pets: post: summary: Add a new pet requestBody: $ref: '#/components/requestBodies/PetBody' /pets/{petId} put: summary: Update a pet parameters: [ ... ] requestBody: $ref: '#/components/requestBodies/PetBody' components: requestBodies: PetBody: descript...
OpenAPI 3.0 domains need to have everything under the components section. Note that OpenAPI 3.0 uses schemas instead of definitions. components: schemas: ... pathitems: ... parameters: ... requestBodies: ... responses: ... headers: ... examples: ... links: ... callbacks: ... See Op...
不支援含有以下內容的 OpenAPI 第 3 版輸入檔:$ref內容參照其他位置中的元素而不是#/components/schemas/name(用於綱目)、#/components/parameters/name(用於參數)、#/components/responses/name(用於回應)、#/components/requestBodies/name(用於要求內文)或#/components/securitySchemes/name(用於安全綱目)。
不支持具有引用以下位置之外元素的$ref属性的 OpenAPI v3 输入文件:#/components/schemas/name(针对模式)、#/components/parameters/name(针对参数)、#/components/responses/name(针对响应)、#/components/requestBodies/name(针对请求主体)或#/components/securitySchemes/name(针对安全方案)。
对象类型:Components Object 这个模块主要提供每个OpenAPI自定义的字段定义,这部分定义的对象往往被paths中具体API进行引用: − 响应 responses − 参数 parameters − 示例 examples − 请求体 requestBodies − 标题 headers − 链接 links − 回调 callbacks ...
Components 对象 Paths 对象 Path Item 对象 Operation 对象 External Documentation 对象 Parameter 对象 Request Body 对象 Media Type 对象 Encoding 对象 Responses 对象 Response 对象 Callback 对象 Example 对象 Link 对象 Header 对象 Tag 对象 Reference 对象 ...
对象类型:Components Object 这个模块主要提供每个OpenAPI自定义的字段定义,这部分定义的对象往往被paths中具体API进行引用: − 响应 responses − 参数 parameters − 示例 examples − 请求体 requestBodies − 标题 headers − 链接 links − 回调 callbacks ...