Implement Problem Details for HTTP APIs (RFC 9457) for api errors

未关闭
#495 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
java
领域
api, backend

调研方向

首先阅读 RFC 9457 和 issue 中链接的 Spring MVC Problem Details 参考文档,然后检查 API 当前的错误响应和异常处理。完成的标准是 API 错误返回符合所选标准的描述性响应,以便 frontend 可以将其呈现给用户。

由索引模型根据 Issue 内容生成。

描述

The API should return more descriptive errors, rather than just plain status code errors, such that the frontend can display this information in a more user friendly (and descriptive) manner.

A suggestion is to implement the well known RFC 9457 standard for this, as documented here: https://datatracker.ietf.org/doc/html/rfc9457
Spring (and other frameworks) also has out-of-the-box support for this, e.g.: https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-ann-rest-exceptions.html

As discussed in community meeting in August.

主要语言
Java
星标
34
派生
34
平均合并
9 分钟
30 天内合并 PR
4

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

InseeFrLab/onyxia-api 的其他 Issue

查看 InseeFrLab/onyxia-api 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。