RFC-7807 for errors
- 主要言語
- TypeScript
- スター
- 46
- フォーク
- 4
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
In combination with `fastify.sensible`, make it easy to send well-formatted errors to clients, with actionable details for better DX.
Specification: https://tools.ietf.org/html/rfc7807
Copy-pasta from another project:
```ts
// https://tools.ietf.org/html/rfc7807
import { STATUS_CODES } from 'node:http'
import { z } from 'zod'
export const rfc7807Schema = z.object({
status: z
.number()
.int()
.refine(code => code in STATUS_CODES),
type: z.string().url().optional(), // Technically a URI, but let's not split hairs
title: z.string(),
detail: z.string().optional(),
instance: z.string().url().optional()
})
export type RFC7807 = z.TypeOf
export class RFC7807Error extends Error {
readonly rfc7807: RFC7807
constructor(args: RFC7807) {
super(
`${STATUS_CODES[args.status]}: ${args.title}${
args.detail ? ` (${args.detail})` : ''
}`
)
this.name = 'RFC7807Error'
this.rfc7807 = {
...args,
type: args.type ?? 'about:blank'
}
}
}
```
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
Look at the existing error handling in fastify-micro, likely in a plugin or middleware. Integrate the provided RFC7807 schema and error class, ensuring compatibility with fastify.sensible. Test by creating errors and verifying the response format matches the RFC.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- nodejs, typescript
- 領域
- api, backend
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100