文档写作规范 - LiteOS

开发规范

开发规范 如果用户在APP的开发中，使用了连接池机制，那么需要遵循如下规范，否则，连接池里面的连接就是有状态的，会对用户后续使用连接池进行操作的正确性带来影响。 如果在连接中设置了GUC参数，那么在将连接归还连接池之前，必须使用“SET SESSION

开发规范

开发规范 如果用户在APP的开发中，使用了连接池机制，那么需要遵循如下规范，否则，连接池里面的连接就是有状态的，会对用户后续使用连接池进行操作的正确性带来影响。 如果在连接中设置了GUC参数，那么在将连接归还连接池之前，必须使用“SET SESSION

开发规范

开发规范 规则 多方安全计算中，基础的sql语法都能够支持，但无法支撑所有特殊语法。 语法规则如下： 图1 语法规则 建议及示例 查询示例中两表joi

模板写作指南 - 应用管理与运维平台 ServiceStage

模板写作指南 CAM基于原生Terraform语法，同时针对以应用为中心的目的，增加了一些约束和规范。 本章通过部署一个简单的CCE镜像Nginx的RF模板作为具体的例子来介绍自定义模板的书写过程，可以下载下面的模板文件后对照阅读。 https://cam-bucket-public-cn-south-1

API描述文档规范

API描述文档规范 微服务/业务应用必须基于SWAGGER OPENAPI标准，提供API描述文档。文档路径缺省为http://app-url/resources/microservices/{服务名}.yaml 父主题： API设计规范

API设计规范

API设计规范 URI设计规范 谓词/操作使用规范 参数设计规范 消息体设计规范 HTTP状态码规范 异步处理设计规范 版本设计规范 API描述文档规范 父主题：

版本设计规范

范围内。整个弃用过程必须遵循如下规范。 通知&协议 当服务提供者需要弃用 API 时，必须确保通知到所有使用API 服务的客户端，并且针对弃用的。服务提供者应该提供一些辅助手段来引导客户迁移到新的 API 上，比如提供迁移文档。当所有的客户端迁移到新的API后，服务提供者可以将API

模板写作技巧 - 资源编排服务 RFS

模板写作技巧 组件启动等待 假设，您要启动A（Application）和S（Service）两个组件，并且A依赖S（即：A -> S），A需要去连接S做业务。以A为Tomcat，S为MySQL为例。 AOS编排时，会根据模板要求先启动S，待S启动成功后（进程启动成功，实际S的业务

参数设计规范

参数设计规范 参数类型及使用规范 REST API包括4种类型的参数：Header，Path，Query，Body，说明和约定如下。 Header类型参数【规则】原则上不允许将业务参数定义为Header类型 说明： 按习惯，Hea

HTTP状态码规范

HTTP状态码规范 API服务的HTTP状态返回码，规约如下： 200 OK 成功返回状态，对应GET、PUT、PATCH和DELETE。