Router events (enabling route documentation) – feature request
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- express, javascript, node.js
调研方向
首先查看 issue 讨论以及链接的示例模块 mk-express-router-doc,以了解拟议的 router wrapper 和事件行为。确定添加 middleware、route 或方法处理器时事件的范围和 API,包括是否包含路由文档元数据。完成的标准是确定一项已达成共识的实现方向,并配套相应的文档和测试,但这里不指定目标文件或测试。
由索引模型根据 Issue 内容生成。
描述
I am very fond of the express router for it provides a great deal of flexibility. But I have somewhat problems keeping track of all the routes, middleware locations and methods.
It would be great if there was an event implementation that fires up, if e.g. a middleware handler, another route or a method handler is added.
It would then be easy to keep track of the routes and eventually build a documentation.
Since the lines above might not well explain what I have in mind, I have given this some more thought an created a little example module, which is basically a wrapper/decorator for the express router, which sort of mimics and extends the express router behavior.
I hope this example helps explaining why an evented router might be helpful indeed. It's not great code, but rather a quick and dirty hack:
https://github.com/mkastner/mk-express-router-doc
I don't want to be pushing this too far: but if one could add some documentation on the fly to each respective route and path – that would be the icing on the cake.
- 主要语言
- JavaScript
- 星标
- 69.7k
- 派生
- 25.6k
- 平均合并
- 2 天 9 小时
- 30 天内合并 PR
- 4
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
expressjs/express 的其他 Issue
-
Outdated res.send() syntax in lib/response.js documentation example可能重新可做 关联的 PR 已关闭且未合并。 未关闭docs
难度 1/5 1 小时以内 新手友好度 95/100
expressjs/express#7588 · 1 条评论 ·
维护者通常 1 天内回复
-
4.x deps module:body-parser
难度 1/5 1 小时以内 新手友好度 75/100
expressjs/express#7564 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
Update to mocha 12.x可能已有人在做 @ganeshghutukade-04 于 26 天前认领。 未关闭deps
难度 2/5 1-3 小时 新手友好度 67/100
expressjs/express#7547 · 6 条评论 ·
维护者通常 1 天内回复
-
req.subdomains splits an IPv6 host that contains dots可能已有人在做 @johnnyhuirilef 于 30 天前认领。 未关闭4.x 5.x bug
难度 2/5 1-3 小时 新手友好度 72/100
expressjs/express#7532 · 2 条评论 ·
维护者通常 1 天内回复
-
Readme: project name 'express.js' is not capitalized可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 1/5 1 小时以内 新手友好度 95/100
维护者通常 1 天内回复
查看 expressjs/express 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
ipfs/ipfs-webui#2507 ·
-
Environments table lists page size 5 after 30可能已有人在做 @raus7n 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 90/100
litmuschaos/litmus#5743 ·
维护者通常 2 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 63/100
anothaDev/luci-theme-vantage#143 ·
维护者通常 1 天内回复
-
desktop grp:admin-donors type:graphics-bug ui-admin
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
kingcharleslzy-ai/dsh-purge#282 ·
维护者通常 1 天内回复