← 返回
未分类

Web 接口契约

Web 接口契约,包含 DTO/VO 定义与异常处理。
user_49d740fd
未分类 community v1.0.0 1 版本 100000 Key: 无需
★ 0
Stars
📥 121
下载
💾 1
安装
1
版本
#latest

概述

API Design Contract

使用 @RestController@RequestMapping

HTTP Method 语义要准确:

  • GET: 查询
  • POST: 新增/复杂查询
  • PUT: 全量修改
  • DELETE: 删除

如果之前的 Controller 接口中有使用 @Log 来标记日志,则需要模仿之前的进行添加;如果没有则无需添加。

所有接口必须返回统一包装类 HttpResult

字段包含:code (int), msg (String), data (T)。

需要查看 HttpResult 实体中具体的成功和失败的方法来使用。

禁止在 Controller 中 try-catch。

异常统一抛出,由 @RestControllerAdvice 全局异常处理器捕获并转换输出。

版本历史

共 1 个版本

  • v1.0.0 Initial release 当前
    2026-04-01 17:28 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

dev-programming

YouTube

byungkyu
使用托管OAuth集成YouTube Data API,支持搜索视频、管理播放列表、获取频道数据及评论互动,适用于用户需要时使用此技能。
★ 142 📥 42,220
dev-programming

Mcporter

steipete
使用 mcporter CLI 直接列出、配置、认证及调用 MCP 服务器/工具(支持 HTTP 或 stdio),涵盖临时服务器、配置编辑及 CLI/类型生成功能。
★ 199 📥 68,370
dev-programming

Docker Essentials

arnarsson
核心 Docker 命令和工作流程,包括容器管理、镜像操作和调试。
★ 39 📥 32,749