Provide a fluent API for snippet configuration
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
Start by reviewing the existing varargs-based responseFields and requestFields APIs, then investigate the Spring MVC usage pattern mentioned in the issue. Done means providing a fluent builder API alongside the current approach with equivalent request and response field configuration.
由索引模型根据 Issue 内容生成。
描述
Since REST assured is based on a fluent API it would be awesome if Spring REST docs could provide a fluent (builder) API in addition to the varargs based approach.
(haven't looked in the Spring MVC usage pattern yet).
For example, instead of
responseFields(
fieldWithPath("contact").description("The user's contact details"),
fieldWithPath("contact.email").description("The user's email address"))
maybe sth like
request()
.param("id","User's id")
response()
.field("contact","The user's contact details")
.field("contact.email","The user's email address")
Just a minor enhancement but would probably better align the paradigms. Nothing serious ;-)
- 主要语言
- 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 小时 新手友好度 76/100
checkstyle/checkstyle#22153 ·
维护者通常 1 天内回复
-
Documentation Needs Triage
难度 1/5 1 小时以内 新手友好度 78/100
frankframework/frankframework#11908 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
ome/ome-codecs#48 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
tonihele/OpenKeeper#672 ·
维护者通常 4 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
eclipse-ee4j/angus-mail#224 ·