Provide a snippet for documenting request and response structure
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 38/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- java
调研方向
Start by locating the request and response fields snippets and reviewing how they currently render tables. Compare their output with the nested JSON example in the issue; done means nested payload structure is represented more clearly, ideally with collapsible sections or the proposed structured format.
由索引模型根据 Issue 内容生成。
描述
With complex, heavily nested payloads some people have found the table of fields that's currently produced by the request and response fields snippets a little difficult to use when trying to determine the structure.
A suggestion has been to reflect the nesting in the documentation, ideally with collapsible sections. A relatively simple, albeit without collapsible sections, approach would be something like this:
{
"userName": String,
"name": {
"familyName": String,
"givenName": "String
},
"phoneNumbers": [ {
"value": String
} ],
"emails": [ {
"value": String,
"primary": Boolean
} ],
"active": Boolean,
"verified": Boolean,
"origin": String,
"externalId": String
}
- 主要语言
- Java
- 星标
- 1.2k
- 派生
- 733
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
spring-projects/spring-restdocs 的其他 Issue
-
status: waiting-for-triage
难度 4/5 3-5 天 新手友好度 35/100
spring-projects/spring-restdocs#1075 ·
-
Support extracting Bean Validation constraints from method parameters可能重新可做 关联的 PR 已关闭且未合并。 未关闭status: waiting-for-triage
难度 5/5 一周以上 新手友好度 45/100
spring-projects/spring-restdocs#1026 · 2 条评论 ·
-
status: blocked status: waiting-for-triage
难度 4/5 3-5 天 新手友好度 35/100
spring-projects/spring-restdocs#953 · 7 条评论 ·
-
Add support for modifying a URI's path during pre-processing可能重新可做 关联的 PR 已关闭且未合并。 未关闭type: enhancement
难度 3/5 1-2 天 新手友好度 45/100
-
status: feedback-provided status: waiting-for-triage
难度 3/5 1-2 天 新手友好度 45/100
spring-projects/spring-restdocs#937 · 4 条评论 ·
查看 spring-projects/spring-restdocs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
strimzi/strimzi-kafka-operator#13328 · 1 条评论 · 3 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
GoogleContainerTools/jib#4538 ·
-
难度 2/5 1-3 小时 新手友好度 67/100
OpenLiberty/ci.maven#2137 ·
维护者通常 1 天内回复
-
Payer adjustment can exceed the balance left after copay and deductible, so claim payments add up to more than the charge可能已有人在做 @DG47 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 79/100
synthetichealth/synthea#1772 ·
维护者通常 13 天内回复
-
bug dependencies
难度 2/5 1-3 小时 新手友好度 65/100