Support for passing custom values/services into Snippet classes
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
调研方向
Start by reviewing the Snippet and Operation APIs, then inspect the linked OperationAttributeHelper.java and JacksonResultHandlers.java examples to understand how per-request values currently flow through MockHttpServletRequest attributes. Define what public customization API would let Snippet classes receive request-specific services and values without relying on internal attributes; done means the requested use case no longer needs that hack.
由索引模型根据 Issue 内容生成。
描述
In our auto-documentation extension https://github.com/ScaCap/spring-auto-restdocs we are trying to automate documentation as much as possible by introspecting code. For this we created extensions of Snippets which are dependent on some common services, such as jackson ObjectMapper, custom constraints & javadoc reader, having HandlerMethod available etc.
For passing these common components around, we are doing little hack by putting custom attributes inside MockHttpServletRequest, then inside the Snippet class getting them from Operation attributes:
public static ObjectMapper getObjectMapper(Operation operation) {
return (ObjectMapper) operation.getAttributes().get(ObjectMapper.class.getName());
}
public static void setObjectMapper(MockHttpServletRequest request, ObjectMapper objectMapper) {
((Map) request.getAttribute(ATTRIBUTE_NAME_CONFIGURATION))
.put(ObjectMapper.class.getName(), objectMapper);
}
We are setting it for every request using custom ResultHandler and alwaysDo mechanism.
public void handle(MvcResult result) throws Exception {
setHandlerMethod(result.getRequest(), (HandlerMethod) result.getHandler());
setObjectMapper(result.getRequest(), objectMapper);
...
Because we need custom data for every request, such as request pattern and HandlerMethod, we cannot configure these things statically during Snippet class creation.
As this mechanism is basically a hack to inner workings of spring-restdocs (discovered how these attributes are passed around by digging in source code) and it's prone to change as it's internal api, it would be great if this framework offers customization of such things out of the box. Could be still using these attributes internally but having some convenient public api.
- 主要语言
- 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
-
Bug
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
protobuf
难度 2/5 1-3 小时 新手友好度 84/100
FasterXML/jackson-dataformats-binary#874 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 75/100
-
Add the AI-disclosure footer to README.md可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 1/5 1 小时以内 新手友好度 85/100
-
Add the AI-disclosure footer to README.md可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 62/100
HexaHexes/infinite-dungeon-spawn-safety#17 ·
维护者通常 1 天内回复