API编写规范

xiaoqibTn 发布于2019-08-16 10:34 / 2497人阅读

摘要：为什么设计详情规范主要是为了保证公司的小伙伴写出的尽量少出，加快研发速度。

为什么设计api详情规范

主要是为了保证公司的小伙伴写出的api尽量少出bug，加快研发速度。

api 设计规范

绝大部分api都请务必加入用户id限定，主要为了防止某个用户可以请求所有的数据库数据；

管理员api，必须加入 @Secured(AuthorityConstants.ADMIN) 保证该api只能使用管理员账号才能访问；

所有的api都必须加入严格的参数验证机制，保证参数不合法的时候请求快速报错，减少数据库以及微服务的压力；

所有的api都必须要保证api可以向前兼容，api以增加为主、修改为辅；

api控制层，只做参数验证，不做业务逻辑，所有的业务逻辑都应该放到业务层；

GPU云服务器云服务器编写规范 java编写规范 html页面编写规范 api接口规范

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/70041.html

前端背景知识查漏补缺

摘要：提交内容可以是一个提议想法初步描述该阶段是对所提交新特性的正式建议。在这个阶段需具备以下条件指定一名成员作为审阅通过有实现的或者初步编写标准，包括问题描述解决方案示例语法语义关键的算法及抽象实现在的复杂度等该阶段是会出现标准中的第一个版本。 ECMAScript 与 JavaScript ECMAScript 是一套脚本语言的规范，内部编号 ECMA-262 该规范由 Ecma(Eu...

developerworks 2019-08-22 15:53 评论0 收藏0
前端背景知识查漏补缺

摘要：提交内容可以是一个提议想法初步描述该阶段是对所提交新特性的正式建议。在这个阶段需具备以下条件指定一名成员作为审阅通过有实现的或者初步编写标准，包括问题描述解决方案示例语法语义关键的算法及抽象实现在的复杂度等该阶段是会出现标准中的第一个版本。 ECMAScript 与 JavaScript ECMAScript 是一套脚本语言的规范，内部编号 ECMA-262 该规范由 Ecma(Eu...

incredible 2019-08-02 10:03 评论0 收藏0
自动化代码生成工具 Snips 开发实践

摘要：今天我来和大家分享一下以及自动化生成工具的开发经验。代码生成工具接着讲讲代码生成工具，对于来讲，有官方的代码生成器，还有其他的同类开源项目比如。现有的代码生成器没有可以开箱即用的，都需要去进行不少的修改。前言在开发工作中，经常会遇到新产品、服务上线后，需要将其 API 编写不同语言的 SDK。但不同语言 SDK 中都有很大一部分内容是用来进行 API 的描述，而且这部分代码量是最大...

only_do 2019-08-21 11:20 评论0 收藏0