APIPatterns / APIPatterns/PatternsLibrary

Implement linter to warn for required fields in `body`

未关闭
#4 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
good first issue linter
主要语言
TypeScript
星标
1
派生
0
PR 合并指标
30 天内没有已合并 PR

描述

We are exploring the use of required fields in request/response bodies. Often, these can be very problematic, e.g. if something changes from optional to required, you want to return/send only a 'partial' resource, etc. Because of versioning, client and server code has to handle changes to the resource structure anyway. Making everything optional enables greater flexibility in what can flow over the wire.

> Mark a field as `required` only when it must absolutely be present on every request/response for every version of the API.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

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