如需了解国际站更多云产品，请访问国际站。https://www.huaweicloud.com/intl/
不再显示此消息
如需了解国际站更多云产品，请访问国际站。https://www.huaweicloud.com/intl/
不再显示此消息
API设计规范 URI设计规范 谓词/操作使用规范 参数设计规范 消息体设计规范 HTTP状态码规范 异步处理设计规范 版本设计规范 API描述文档规范 父主题：
在项目中引入commit message规范已是迫在眉睫。用什么规范？现在市面上比较流行的方案是约定式提交规范（Conventional Commits），它受到了Angular提交准则的启发，并在很大程度上以其为依据。约定式提交规范是一种基于提交消息的轻量级约定。
支持API级权限管理，可配置化实现针对特定应用的可开放API。应用部署包制作规范部署包使用helm chart格式归档发布Web、接口类应用采用deployment部署，支持至少2个副本并优先根据反亲和性要求调度到不同的k8s集群工作节点。
父主题： API设计规范
HTTP状态码规范 API服务的HTTP状态返回码，规约如下： 200 OK 成功返回状态，对应GET、PUT、PATCH和DELETE。
编辑 注意要点 架构图的名词表达要到位，比如：业务架构图和运维架构图中不能出现技术的字眼。因为不同架构图的读者是不同的，要保证你的读者能迅速的get 到你想表达的意思，这是很重要的。
API描述文档规范 微服务/业务应用必须基于SWAGGER OPENAPI标准，提供API描述文档。
版本设计规范 API只能在破坏性改动时出现版本。服务端必须以兼容扩展的方式来避免产生API版本。API版本化会导致理解、测试、维护、变更、运维、发布系统变得非常困难。
(MUST) 父主题： API设计规范
–以下正文– 以往在使用eslint对代码进行规范的时候，经常遇到校验与自动化格式化规则不同的问题，比如eslint中规定末尾必须使用分号，那么你开发工具中代码美化插件也需要配置相应的格式化规则，这是比较麻烦的，所以standard规范太霸道了，大家开发基本都不会去用。
URI设计规范 URI命名规则： URI命名时只采用小写字母、数字和减号，所有URI对于客户端和服务端来说必须是大小写敏感的，为了避免歧义，我们尽量用小写字符；即URI中字段命名采用英文半角小写字母、数字、减号组合，如“api-docs”，不建议采用驼峰式命名。
支持指标、日志、事件等多种类型数据的统一存储和分析；实现对IT环境各个资源及设备运行情况的综合分析，提升现有IT运维管理水平。
c++代码使用cppcheck检查、python代码使用pylint检查代码规范性。
尽量不要用tab制表符，使用不同的源代码管理工具时，tab字符将因为用户设置的不同而扩展为不同的宽度。 （6）尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好地处理，但这一设置可以灵活进行调整。
SQL规范SQL语句的长度不能超过1MB，否则会报错。常量字符串最大支持8000个字节。表的单行长度（指单行所有列占用字符之和）最大支持64000个字节。注释规范GaussDB 100的SQL脚本支持两种注释方式：单行注释格式：-- 注释内容。多行注释格式：/*注释内容*/。
【功能模块】规范设计是否支持MySQL？从支持的数据源看： DGC支持的数据源_数据湖治理中心 DGC_用户指南_管理中心_华为云 (huaweicloud.com) DGC的规范设计不支持MySQL。
本版发帖规范：禁止违反国家法律法规的贴；禁止人身攻击贴；禁止骂人贴；禁止各种购物类链接贴；禁止恶意水贴；禁止发布过激言论；发帖建议：合理分类，二次开发，问题求助，交流分享，请对号入座；发帖名称建议，除以及标签之外，发帖是注明自己问题的模块，例如【容器】【应用】【终端】【配置】等，格式可参考
支持API级权限管理，可配置化实现针对特定应用的可开放API。应用部署包制作规范部署包使用helm chart格式归档发布Web、接口类应用采用deployment部署，支持至少2个副本并优先根据反亲和性要求调度到不同的k8s集群工作节点。
各层命名规约：A) Service/DAO 层方法命名规约1） 获取单个对象的方法用 get 做前缀。2） 获取多个对象的方法用 list 做前缀。3） 获取统计值的方法用 count 做前缀。4） 插入的方法用 save/insert 做前缀。5） 删除的方法用 remove/delete
1.1 文件夹命名规范推荐命名规范- 建议按照项目名称、开发关键步骤环节与场景进行层级管理及命名，如果是便于不同的电脑便于移植，建议使用@{WORK_DIR}，保存与读取文件夹下的文件。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
您即将访问非华为云网站，请注意账号财产安全
