工业互联网平台开放接口标准化规范.docxVIP

工业互联网平台开放接口标准化规范

_标准化文件Ver1.0_

1.总则

1.1目的

定义工业互联网平台对外开放接口的设计原则、技术规范及安全要求，确保接口的兼容性、安全性与互操作性，助力工业生态体系建设。

1.2适用范围

适用于工业互联网平台对接口开放标准的制定、开发与管理，明确API接口设计、部署、安全与运维要求。

2.总体原则

2.1通用架构与风格

采用RESTful架构风格。

使用HTTP作为传输协议，优先使用HTTPS确保数据传输安全。

2.2安全优先

强制鉴权机制（OAuth2.0或API密钥）

请求数据加密入库

防止DDoS攻击、API滥用防护

3.接口设计规范

3.1接口命名规范

使用资源/动作方式命名，如/devices/{deviceId}/status

支持子资源路径方式，避免使用NestJS式过深命名

3.2HTTP方法规范

方法

功能描述

GET

获取指定资源

POST

创建资源或提交处理请求

PUT

更新整个资源

PATCH

局部修改资源

3.3请求与响应规范

3.3.1请求参数

查询参数：？key1=value1＆key2=value2

请求体参数：JSON格式，类型识别遵循JSONSchema（扩展OpenAPI定义）

3.3.2应用状态码

类型

代码

说明

成功

200

成功回应

创建

201

已创建资源

转重定向