Documentation for header

floatdrop / express-request-id

Middleware for setting unique request id

MIT License

120 stars 24 forks source link

Documentation for header #1

Closed bradisbell closed 9 years ago

bradisbell commented 9 years ago

This is helpful middleware. Just a note... it wasn't clear what header was being set without digging into the code. Maybe the README could have something that mentions X-Request-Id, and clarifies that the header is a response header and not something tacked onto the existing request headers.

floatdrop commented 9 years ago

Thanks. Clarified thing about header in top of readme.

lonix1 commented 5 years ago

The docs are still misleading... Took me a while to deduce:

a uuid is generated
it is added to a new id property on the express req object
it is added to a new X-Request-Id header on the express res object

If the above is correct then it should be used in the docs.