2024工业互联网平台接口开发规范

工业互联网平台接口开发规范工业互联网平台接口开发规范目录第一章概述 31.1.介绍 31.2.编写目的 31.3.编写原则 31.4.变更历史 5第二章接口开发过程 5第三章接口规范 53.1.接口地址命名规范 53.2.微服务组件服务命名规范 63.3.目录第一章概述 31.1.介绍 31.2.编写目的 31.3.编写原则 31.4.变更历史 5第二章接口开发过程 5第三章接口规范 53.1.接口地址命名规范 53.2.微服务组件服务命名规范 63.3.接口调用规范 73.4.CRUD资源规范 73.4.1.添加资源 73.4.2.删除资源 73.4.3.更新资源 83.4.4.获取列表 83.4.5.获取详情 93.4.6.搜索条件 102第一章概述1.1.介绍RESTwebURLRESTfulWebHTTP来表示不同的操作的调用。RESTCRUDHTTPPOST-创建资源第一章概述1.1.介绍RESTwebURLRESTfulWebHTTP来表示不同的操作的调用。RESTCRUDHTTPPOST-创建资源GET-检索资源PUT–更新资源DELETE-删除资源RESTJavanetPHP们都依赖基本HTTP协议。1.2.编写目的编写本文的目的是为了将系统功能进行模块化、服务化，将用户的操作以服务的方式提供。系统与系统之间遵循服务规范，将系统与系统之间的交互转为定制化服务交互，以实现系统与系统之间的集成。1.3.编写原则3（Addressability）RESTOOP必须可以通过URI寻址或访问。接口一致性（Interfaceuniformity）SOAPRESTfulHTTP支持的方法，比如GET、PUT（Addressability）RESTOOP必须可以通过URI寻址或访问。接口一致性（Interfaceuniformity）SOAPRESTfulHTTP支持的方法，比如GET、PUTPOSTDELETEWSDL储客户机的状态信息。这使服务器不与特定的客户机相绑定，负载平衡变得简单多了。这还让服务器更容易监视、更可靠。具象（Representational）客户机总是与资源的某种具象交互，绝不会直接与资源本身交互。同一资源还可以有多个具象。理论上说，持有资源的具象的任何客户机应该有操纵底层资源的足够信息。连通性（Connectedness）任何基于REST的系统都应该预见到客户机需要访问相关的资源，应该在返回的资源具象中包含这些资源。例如，可以以超链接的形式包含特定RESTful服务的操作序列中的相关步骤，让客户机可以根据需要访问它们。41.4.变更历史第二章接口开发过程审核人：质量管控：第三章接口规范命名约定：全小写的英文加数字禁止内容：未经允许，请勿英文和汉语拼音，以及大小写混合命名1.5.接口地址命名规范5类别组件名称接口地址app目标管理Appapp/target/**无人值守Appapp/ugs/**序号变更人员变更时间变更内容1.4.变更历史第二章接口开发过程审核人：质量管控：第三章接口规范命名约定：全小写的英文加数字禁止内容：未经允许，请勿英文和汉语拼音，以及大小写混合命名1.5.接口地址命名规范5类别组件名称接口地址app目标管理Appapp/target/**无人值守Appapp/ugs/**序号变更人员变更时间变更内容token接口，接口地址为：sys/auth/gettoken。远程调用完整地址为：域名+端口号+接口地址。1.6.微服务组件服务命名规范app“target-management-app”。6设备运维Appapp/pms/**车间设备联网Appapp/tpm/**环境监测Appapp/emis/**hr人资管理基础服务hr/**iot物联云基础服务iot/**mes制造云基础服务mes/**crm营销云基础服务crm/**pdm设计管理pdm/**mms物料管理mms/**qms质量管理qms/**bi商业智能bi/**erp财务管理erp/**activity工作流服务activity/**sys平台基础服务sys/**统一认证服务sys/auth/**用户管理sys/user/**部门管理token接口，接口地址为：sys/auth/gettoken。远程调用完整地址为：域名+端口号+接口地址。1.6.微服务组件服务命名规范app“target-management-app”。6设备运维Appapp/pms/**车间设备联网Appapp/tpm/**环境监测Appapp/emis/**hr人资管理基础服务hr/**iot物联云基础服务iot/**mes制造云基础服务mes/**crm营销云基础服务crm/**pdm设计管理pdm/**mms物料管理mms/**qms质量管理qms/**bi商业智能bi/**erp财务管理erp/**activity工作流服务activity/**sys平台基础服务sys/**统一认证服务sys/auth/**用户管理sys/user/**部门管理sysDepart/**字典管理sys/dict/**1.7.接口调用规范httpfeignheaderX_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。feignjeecg-boot-starter-cloud模 块 下 的FeignConfig类 中 的requestInterceptorhttp远程调用方式可采用httpClient,同样需要在请求header中加入“X_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。1.8.CRUD1.8.1.添加资源1.7.接口调用规范httpfeignheaderX_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。feignjeecg-boot-starter-cloud模 块 下 的FeignConfig类 中 的requestInterceptorhttp远程调用方式可采用httpClient,同样需要在请求header中加入“X_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。1.8.CRUD1.8.1.添加资源1.8.2.删除资源7请求方式DELETE请求方式POST服务路径/api/XXX/参数类型application/json参数描述{“key”:”value”}备注：key：键，value:值返回值类型application/json描述{code:200,msg:"success",data:{}}1.8.3.更新资源1.8.4.获取列表8请求方式GET请求方式PUT服务路径/api/XXX/{id}参数类型application/json参数描述{“key”:”value”}备注：key：键，value:值返回值类型application/json描述{code:200,msg:"success",data:{}}服务路径/api/XXX/{id}参数类型无参数描述无返回值类型application/json描述{code:200,1.8.3.更新资源1.8.4.获取列表8请求方式GET请求方式PUT服务路径/api/XXX/{id}参数类型application/json参数描述{“key”:”value”}备注：key：键，value:值返回值类型application/json描述{code:200,msg:"success",data:{}}服务路径/api/XXX/{id}参数类型无参数描述无返回值类型application/json描述{code:200,msg:"success",data:{}}1.8.5.获取详情9请求方式GET服务路径/api/XXX/{id}参数类型无参数描述无返回值类型application/json描述{code:200,msg:"success",data:{}}服务路径/api/XXX/参数类型无参数描述无返回值类型application/json描述{code:200,1.8.5.获取详情9请求方式GET服务路径/api/XXX/{id}参数类型无参数描述无返回值类型application/json描述{code:200,msg:"success",data:{}}服务路径/api/XXX/参数类型无参数描述无返回值类型application/json描述{code:200,msg:"success",data:{list:[],pagination:{currentPage:1,pageSize:20,total:2000}}}1.8.6.搜索条件10分页列表通用搜索条件{keyword:'',//关键字，默认为空sort:'', //排序方式(dsc,asc),默认1.8.6.搜索条件10分页列表通用搜索条件{keyword:'',//关键字，默认为空sort:'', //排序方式(dsc,asc),默认sidx:'', //排序字段currentPage: