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

Java技术栈 —— 基本规范

Java技术栈 —— 基本规范

  • 一、接口文档生成工具
  • 二、接口设计与开发顺序
  • 三、数据类封装

一、接口文档生成工具

有很多jar包都支持swagger的接口文档,这样方便了接口测试,不需要用apifox自己写接口,直接调用文档里的swagger接口文档即可,但是市面上支持swagger的jar包众多,如何选,哪个好,这是需要比较才知道的。推荐Springdoc。

参考文章或视频链接
[1] Springfox、Swagger 和 Springdoc
[2] 从 SpringFox 迁移到 SpringDoc - 知乎
[3] 前后端分离模式中,swagger VS springdoc,你会用哪个? - 知乎

二、接口设计与开发顺序

顺序:增(Create)→ 查(Read)→ 改(Update)→ 删(Delete)
对应 HTTP 方法:POST → GET → PUT/PATCH → DELETE
逻辑合理性
资源创建优先:用户通常需要先创建资源(如注册用户、新增文章),才能进行后续操作。
生命周期连贯:符合资源从“诞生”到“消亡”的自然流程:创建 → 查看 → 修改 → 删除。
开发文档友好:API 文档中按此顺序排列,便于开发者理解接口的完整流程。

# 示例(用户接口)
POST /users → 新增用户
GET /users/{id} → 查询用户
PUT /users/{id} → 修改用户
DELETE /users/{id} → 删除用户

三、数据类封装

数据库表 ← entity ← [bo] ← 前端

数据库表 → entity → [vo] → 前端
bo = business object,即业务对象
vo = view object,即可视化对象

http://www.xdnf.cn/news/45469.html

相关文章:

  • [matlab]子图排版和线性回归
  • 基于Python智能体API的Word自动化排版系统:从零构建全流程模块化工作流与版本控制研究
  • MAC-QueryWrapper中用的exists,是不是用join效果更好
  • SpringBoot实战4
  • chili3d调试6 添加左侧面板
  • Linux学习——了解和熟悉Linux系统的远程终端登录
  • 架构师面试(三十四):IM 假在线
  • Qt中修改了UI设计文件后编译不生效问题的解决办法
  • 基于若依开发公网访问项目
  • 精益数据分析(8/126):从Airbnb案例看精益创业与数据驱动增长
  • 数据通信学习笔记之OSPF的区域
  • 学习笔记—C++—string(一)
  • 2025年渗透测试面试题总结-拷打题库07(题目+回答)
  • SQL之DML(查询语句:select、where)
  • Mysql insert一条数据的详细过程
  • [SpringBoot-1] 概述和快速入门(使用vscode)
  • 在阿里云和树莓派上编写一个守护进程程序
  • 数据分析师-Part1-职业介绍
  • 每天学一个 Linux 命令(26):less
  • Vue3 响应式原理: Proxy 数据劫持详解
  • Oracle高级语法篇 - 用户与角色关系
  • 从零创建 Docker 镜像
  • DeepSeek与ECharts融合助力复杂图表高效制作
  • Python网络爬虫设计(三)
  • python生成项目依赖文件requirements.txt
  • 计算机组成与体系结构:计算机结构的分类(classifications of computer architecture)
  • 牛客 | OJ在线编程常见输入输出练习
  • Towards Transferable Targeted 3D Adversarial Attack in the Physical World--阅读笔记
  • 深度解析 PointNet:点云深度学习的开山之作
  • 低代码开发平台:企业数字化转型的加速器