# 公共模型
公共模型提供API设计时所需公共数据的定义，在设计API的Body请求体或返回响应时，如果需要使用某种数据模型、公共响应等，可直接引用对应的公共模型，单击"公共模型"搜索框右侧![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515663927.png)，新建不同类型公共模型，CodeArts API提供以下7种公共模型定义：数据模型、公共响应、公共参数、公共请求体、公共示例、安全模型、公共响应头。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483543932.png)
#### 数据模型
数据模型和编程语言里的数据结构概念类似，主要用于接口设计场景中的"返回响应"和json/xml类型的"Body参数"。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515583927.png)
在设计API的Body体或响应体时，可以直接引用公共数据结构。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515583939.png)
数据结构被引用后，可以在数据结构的文档页面查看引用当前数据结构的API和模型，可通过单击引用的API，跳转打开API详情页。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483383972.png)
#### 公共响应
接口的公共响应返回结果，响应类型默认为"application/json"结构。
支持将响应体中数据结构提取为数据模型，以及单击"智能导入"，根据输入的Json自动生成数据结构功能。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483543928.png)
在设计API的响应体时，可以直接引用已设计好的公共响应。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483543940.png)
公共响应文档页面可以查看引用当前公共响应的API，可通过单击引用的API，跳转打开API详情页。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483543942.png)
#### 公共参数
接口的公共请求参数，参数位置可选"query"参数、"path"参数、"header"参数。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483383976.png)
在设计API的请求参数时，可以引用已设计好的公共参数。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515663939.png)
公共参数文档页面可以查看引用当前公共参数的API，可通过单击引用的API，跳转打开API详情页。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483383978.png)
#### 公共请求体
接口的公共请求体，默认请求类型为"application/json"。
支持将请求体中数据结构提取为数据模型，以及单击"智能导入"，根据输入的Json自动生成数据结构功能。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515663921.png)
支持设计Body体引用，并且在公共请求体的文档页面支持查看引用当前公共请求体的API，可通过单击引用的API，跳转打开API详情页。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515663929.png)
#### 公共示例
接口的公共示例，可在API设计请求体示例与返回响应的响应示例中被引用，在公共示例的文档页面可查看引用当前公共示例的API，可通过单击引用的API，跳转打开API详情页。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483383982.png)
 #### 安全模型
安全模型类别提供"http"、"apikey"、"oauth2"、"openIdConnect"四种类型选择，选择不同类型的安全模型后，需要在方案内容中完善相关必填信息，用于API设计中"安全方案"的引用。在安全模型的文档页可以查看引用当前安全模型的API，可通过单击引用的API，跳转打开API详情页。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515663933.png)
#### 公共响应头
接口的公共响应头，在API设计中"返回响应"中响应头可进行公共响应头的引用。在公共响应头的文档页可以查看引用当前公共响应头的API，可通过单击引用的API，跳转打开API详情页。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515583933.png)