企业信息系统微服务开发规范.pdf

企业信息化系统项目建设

开发规范

作者：阿兴

日期：20XX年XX月

1/56

目录

目录2

修订记录5

1.规范概述6

1.1.编写目的6

1.2.适用范围6

1.3.阅读对象6

1.4.技术门槛6

1.5.术语缩写7

2.环境规范8

2.1.开发环境规范8

2.2.运行环境规范9

3.设计规范10

3.1.服务拆分规范10

3.1.1.服务拆分最多三层，两次调用10

3.1.2.服务单向调用，严禁循环调用10

3.1.3.服务调用并行调用或者异步化11

3.1.4.服务接口调用应该实现幂等性11

3.1.5.接口数据定义严禁内嵌，透传12

2/56

3.1.6.服务拆分后，工程命名规范化12

3.2.服务设计规范13

3.2.1.接口设计规范13

3.2.2.分页设计规范14

3.2.3.资源操作规范15

3.2.4.接口响应规范17

3.2.5.接口文档规范19

3.3.VUE设计规范19

4.开发规范21

4.1.服务开发规范21

4.1.1.服务管理规范21

4.1.2.服务开发规范23

4.1.3.服务发布规范24

4.1.4.服务消费规范29

4.1.5.持续集成规范31

4.2.VUE开发规范34

4.2.1.VUE命名规范34

4.2.2.VUE开发规范35

4.2.3.VUE注释规范37

4.2.4.VUE请求规范42

3/56

4.2.5.构建部署规范44

5.管理规范45

5.1.介质管理规范45

5.1.1.介质构建规范45

5.1.2.介质存储规范46

5.1.3.介质使用规范46

5.2.代码管理规范47

5.2.1.代码管理模式47

5.2.2.代码管理规范49

5.3.文档管理规范51

5.3.1.目录结构规范52

5.3.2.文档命名规范54

5.3.3.文档格式规范54

6.最佳实践56

4/56

修订记录

版本号修订日期修订概述修订人审核人批准人备注

V1.0020XX/09/29初稿

5/56

1.规范概述

1.1.编写目的

本规范用于XX科