当前位置: 首页 > article >正文

接口开发基本规范

一、背景

由于进入了外包公司,且相比于我之前的公司,对代码规范要求还是比较严格的。无论是对代码,还是接口请求方式,参数命名都有要求,虽然之前也有这些意识,但是因为没有经常实践,所以也会渐渐淡忘。所以为了加强规范,也会在这篇文章持续记录开发的基本规范。

二、规范事项

接口规范

1、Get与Post请求方法

  • Get修饰不修改资源的方法,比如查询
  • Post修饰修改资源的方法,比如创建、修改、删除等

至于其它的option、put那些,一般我们不会用,只用get、post表示已经可以覆盖全部场景了

2、路径参数与body参数

  • 路径参数用于标识资源或指定唯一标识符,通过URL的路径部分传递。
  • 查询参数用于传递额外的请求参数,通过URL的查询字符串部分传递。

总结

开发基本规范,也有助于自己的底子与开发素养,基本的东西很重要,用到它们的意识也很重要。
这篇接口开发基本规范,我会持续更新,我不会记录很细的细节,我只会记录基本但却很重要的规范。


http://www.kler.cn/news/309607.html

相关文章:

  • 软件测试学习笔记丨Postman基础使用
  • 专业学习|系统动力学概观(方法特色、构成要素、建模步骤)
  • 分集合并技术(MRC技术)
  • 四款视频转文字工具,搞定会议记录!
  • 02 基于STM32的按键控制继电器驱动电机
  • springboot luttuc redis 集成protobuf,手动序列化反序列化
  • C#使用Access数据库使用总结
  • LeetCode 面试经典 150 题回顾
  • 【C++】多态的认识和理解
  • 速通LLaMA2:《Llama 2: Open Foundation and Fine-Tuned Chat Models》全文解读
  • Leetcode 3291. Minimum Number of Valid Strings to Form Target I
  • 线性判别分析 (Linear Discriminant Analysis, LDA)
  • 【Unity学习心得】如何制作俯视角射击游戏
  • vue-router 在新的标签页打开链接/路由
  • 2024.9.11(k8s环境搭建)
  • 如何为 Java 应用程序创建安装程序
  • 《深度学习》【项目】 OpenCV 身份证号识别
  • PostgreSQL 的 logger 进程和 Oracle 的 diag 进程对比
  • SDKMAN!软件开发工具包管理器
  • 基于Spark框架实现XGBoost模型
  • ThinkPHP3改造自定义日志输出
  • setup函数子传父普通写法
  • 一般在写SQL时需要注意哪些问题,可以提高查询的效率?
  • adb install失败: INSTALL_PARSE_FAILED_NO_CERTIFICATES
  • JavaScript高级——闭包应用-自定义js模块
  • 『功能项目』窗口可拖拽脚本【59】
  • 设置spring boot禁止日志输出到控制台
  • c++中的二叉搜索树
  • 前端网络层性能优化
  • 【2024华为杯研究生数学建模竞赛】比赛思路、代码、论文更新中.....