Router events (enabling route documentation) – feature request
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- express, javascript, node.js
Research direction
Start by reviewing the issue discussion and the linked mk-express-router-doc example module to understand the proposed router wrapper and event behavior. Determine the scope and API for events when middleware, routes, or method handlers are added, including whether route documentation metadata is included. Done means an agreed implementation direction with corresponding documentation and tests, but no target files or tests are identified here.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- JavaScript
- Stars
- 69.7k
- Forks
- 25.6k
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from expressjs/express
-
Outdated res.send() syntax in lib/response.js documentation exampleMay be free again A pull request for this issue was closed without being merged. Opendocs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
expressjs/express#7588 · 1 comment ·
Maintainers usually reply within 1 day
-
4.x deps module:body-parser
Difficulty 1/5 Under an hour Newbie friendliness 75/100
expressjs/express#7564 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
Update to mocha 12.xPossibly taken @ganeshghutukade-04 claimed this 26 days ago. Opendeps
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
expressjs/express#7547 · 6 comments ·
Maintainers usually reply within 1 day
-
req.subdomains splits an IPv6 host that contains dotsPossibly taken @johnnyhuirilef claimed this 30 days ago. Open4.x 5.x bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
expressjs/express#7532 · 2 comments ·
Maintainers usually reply within 1 day
-
Readme: project name 'express.js' is not capitalizedMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 95/100
Maintainers usually reply within 1 day
All issues in expressjs/express
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
anothaDev/luci-theme-vantage#143 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
kingcharleslzy-ai/dsh-purge#282 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
a-corriger bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
christian-raj/S-Aloha#340 ·
-
area:image documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day