华为云开发者中心
-
API描述文档规范
API描述文档规范 微服务/业务应用必须基于SWAGGER OPENAPI标准,提供API描述文档。文档路径缺省为http://app-url/resources/microservices/{服务名}.yaml 父主题: API设计规范
-
接口规范文档
对较小。 2)每个单体应用不局限于固定的技术栈,开发者可以自由选择开发技术,提供API服务。 3)每个微服务独立的开发,部署。 4)单一职责功能,每个服务都很简单,只关注于一个业务功能。 5)易于规模化开发,多个开发团队可以并行开发,每个团队负责一项服务。 6)改善故障隔离。一个服务宕机不会影响其他的服务。
-
接口测试--接口文档规范
接口测试的依据,往往不是需求文档,而是接口文档。 那么,接口文档的准确性便至关重要,本文推荐apipost接口文档生成工具生成的接口文档,供大家参考。 接口文档不管以什么形式存在,需要包含的内容有: 1.接口名称2.接口类型3.输入参数4.每个参数名;每个参数类型;每个参数业务含
-
开发规范
开发规范 如果用户在APP的开发中,使用了连接池机制,那么需要遵循如下规范,否则,连接池里面的连接就是有状态的,会对用户后续使用连接池进行操作的正确性带来影响。 如果在连接中设置了GUC参数,那么在将连接归还连接池之前,必须使用“SET SESSION
-
开发规范
开发规范 如果用户在APP的开发中,使用了连接池机制,那么需要遵循如下规范,否则,连接池里面的连接就是有状态的,会对用户后续使用连接池进行操作的正确性带来影响。 如果在连接中设置了GUC参数,那么在将连接归还连接池之前,必须使用“SET SESSION
-
开发规范
开发规范 规则 多方安全计算中,基础的sql语法都能够支持,但无法支撑所有特殊语法。 语法规则如下: 图1 语法规则 建议及示例 查询示例中两表joi
-
API设计规范
API设计规范 URI设计规范 谓词/操作使用规范 参数设计规范 消息体设计规范 HTTP状态码规范 异步处理设计规范 版本设计规范 API描述文档规范 父主题:
-
API 设计规范
Design-First(设计优先) 即优先设计 API 规范,设计完成后再着手进行代码开发工作。推荐使用 OpenAPI-GUI v3 来设计 API 描述文件。 采用 Design-First 就意味着,将设计 API 路由、参数等工作提前,后续整个软件开发的流程都需要围绕着 API 规范为核心,当然这需要有一定的设计经验的开发人员才能胜任。
-
数据服务DO API应用开发规范
2-5-1-1:如果在bpa和sa场景下出现相同名称的API的应用时,作为区分:在bpa场景下名称不需要加后缀,在sa场景下API的应用名称需要加后缀“_sa”。规则 2-5-1-7: API应用名称与API应用ID保持一致。API应用配置规范规则 2-5-1-8:API应用认证类型选择“私钥认证”。R
-
Manager REST API设计开发规范
nbsp; 文档使用Swagger规范(即OpenAPI规范)描述文档,使用Springfox作为文档生成工具其他待补充9 管理规则 8.1 API变更管理要求l