loopbackio / loopbackio/loopback-next
Docs: How to receive context in controller
Abierto
Nadie ha tomado este issue todavía.
developer-experience
Docs
good first issue
help wanted
- Lenguaje dominante
- TypeScript
- Estrellas
- 5.1k
- Forks
- 1.1k
- Merge medio
- 2 d 21 h
- PR fusionados (30 d)
- 27
Descripción
Is there any way to receive the context inside a controller?
Goal is to access request data (headers, ip, etc.)
Thanks
Acceptance criteria
- a section in Controllers.html explaining how to access request and response headers or body by using decorators like
@inject(RestBindings.Http.REQUEST) public request: Requestfor different cases:- A request header shared by most (or all) endpoints and processed by an express middleware/LB4 sequence action. Example: Authorization or X-API-Key.
- A request header shared by many endpoints but used internally in the endpoint implementation (an express route handler/LB4 controller method). Maybe come up with a somewhat realistic example of such header.
- A response header set by an express middleware/LB4 sequence action. For example X-Rate-Limit information provided by a rate-limiting extension in all responses.
- A response header set by the endpoint (an express route handler/LB4 controller method). An example: Location header included ind 201 Created responses.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con Controllers.html y el patrón documentado @inject(RestBindings.Http.REQUEST). Añade ejemplos que cubran las cabeceras o los cuerpos de las solicitudes y respuestas en middleware o acciones de secuencia, así como en métodos de controlador, incluidos los casos de Authorization o X-API-Key, rate-limit y Location; después, verifica que se aborda cada criterio de aceptación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- express, typescript
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 45/100