Router events (enabling route documentation) – feature request

Abierto
#4,523 3 comentarios 5 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
express, javascript, node.js
Área
api, backend

Línea de trabajo

Comienza revisando la discusión del issue y el módulo de ejemplo mk-express-router-doc enlazado para comprender el wrapper del router propuesto y el comportamiento de los eventos. Determina el alcance y la API de los eventos cuando se añaden middleware, rutas o manejadores de métodos, incluido si se incluyen metadatos de documentación de rutas. Se considera terminado cuando exista una dirección de implementación acordada con la documentación y las pruebas correspondientes, pero aquí no se identifican archivos ni pruebas de destino.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

future

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.

Lenguaje dominante
JavaScript
Estrellas
69.7k
Forks
25.6k
Merge medio
2 d 9 h
PR fusionados (30 d)
4

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de expressjs/express

Todos los issues de expressjs/express

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.