loopbackio / loopbackio/loopback-next
Docs: How to receive context in controller
Offen
Dieses Issue hat noch niemand übernommen.
developer-experience
Docs
good first issue
help wanted
- Vorherrschende Sprache
- TypeScript
- Sterne
- 5.1k
- Forks
- 1.1k
- Ø Merge
- 2 T. 21 Std.
- Gemergte PRs (30 T.)
- 27
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit Controllers.html und dem dokumentierten Muster @inject(RestBindings.Http.REQUEST). Füge Beispiele hinzu, die Request- und Response-Header oder -Bodies in Middleware oder Sequence-Actions sowie Controller-Methoden abdecken, einschließlich der Fälle Authorization oder X-API-Key, Rate-Limit und Location, und überprüfe anschließend, dass jedes Akzeptanzkriterium erfüllt ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- express, typescript
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100