Create Kotlin DSL for Spring RestDocs
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 领域
- api, documentation
调研方向
Start by reviewing the converted sample in samples/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.kt and the Kotlin DSL example in this issue. Confirm the desired scope and integration point with maintainers; the issue does not identify target files, tests, or a concrete definition of done.
由索引模型根据 Issue 内容生成。
描述
I've been working on a Kotlin DSL for restDocs and have converted a number of samples to demonstrate it.
I would love to contribute the DSL into the spring-restdocs project. Would you be interested in that DSL? (I also wanted to contribute the base MockMVC DSL to spring test, but that is a different project)
Example DSL:
@Test
fun indexExample() {
this.mockMvc.performGet("/") {
expect { status { isOk } }
document(documentationHandler) {
"notes" link { description("The <<resources-notes,Notes resource>>") }
"tags" link { description("The <<resources-tags,Tags resource>>") }
response {
"Content-Type" header { description("The Content-Type of the payload, e.g. `application/hal+json`") }
"_links" subsection { description("<<resources-index-links,Links>> to other resources") }
}
}
}
}
- 主要语言
- Java
- 星标
- 1.2k
- 派生
- 733
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
spring-projects/spring-restdocs 的其他 Issue
-
type: bug
难度 4/5 3-5 天 新手友好度 35/100
spring-projects/spring-restdocs#1075 · 1 条评论 ·
-
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 小时 新手友好度 82/100
WalletConnect/walletconnect-monorepo#7389 · 1 条评论 ·
-
help wanted testing
难度 2/5 1-3 小时 新手友好度 74/100
elhajahmadj/offline-emergency-library#108 ·
维护者通常 1 天内回复
-
Add documentation for Transaction-bound OTP generation可能已有人在做 @radimtrojek-rgb 今天认领。 未关闭documentation
难度 2/5 1-3 小时 新手友好度 60/100
wultra/powerauth-nextstep#86 ·
-
API `/api/dataverses/{identifier}/dataset/linkingDataverses?alreadyLinking=true` returns at most 1 collection可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭Type: Bug
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 88/100
OpenLineage/OpenLineage#5138 ·
维护者通常 2 天内回复