Router events (enabling route documentation) – feature request
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- express, javascript, node.js
Direzione di ricerca
Inizia esaminando la discussione dell’issue e il modulo di esempio mk-express-router-doc collegato per comprendere il router wrapper proposto e il comportamento degli eventi. Determina l’ambito e l’API degli eventi quando vengono aggiunti middleware, route o gestori di metodi, incluso se sono inclusi i metadati della documentazione delle route. Il lavoro è considerato completato quando è stata concordata una direzione di implementazione con la documentazione e i test corrispondenti, ma qui non vengono identificati file o test di destinazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- JavaScript
- Stelle
- 69.7k
- Fork
- 25.6k
- Merge medio
- 2g 9h
- PR unite (30g)
- 4
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di expressjs/express
-
Outdated res.send() syntax in lib/response.js documentation exampleForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Apertadocs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
expressjs/express#7588 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
4.x deps module:body-parser
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
expressjs/express#7564 · 1 commento · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Update to mocha 12.xForse già presa @ganeshghutukade-04 l’ha presa 26 giorni fa. Apertadeps
Difficoltà 2/5 1-3 ore Idoneità per principianti 67/100
expressjs/express#7547 · 6 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
req.subdomains splits an IPv6 host that contains dotsForse già presa @johnnyhuirilef l’ha presa 30 giorni fa. Aperta4.x 5.x bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
expressjs/express#7532 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Readme: project name 'express.js' is not capitalizedForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di expressjs/express
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 63/100
anothaDev/luci-theme-vantage#143 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
kingcharleslzy-ai/dsh-purge#282 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
-
a-corriger bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
christian-raj/S-Aloha#340 ·
-
area:image documentation good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno