Generator-jhipster: HTTP Header Guidelines

[DanielFran]

This is not to report a bug, but discuss about HTTP best standard practice: https://tools.ietf.org/html/rfc6648.html

Actually in Jhipster header services it is used some header variables with prefix names x- like in HeaderUtil class (https://github.com/jhipster/generator-jhipster/blob/master/generators/server/templates/src/main/java/package/web/rest/util/HeaderUtil.java.ejs) or PaginationUtil class (https://github.com/jhipster/generator-jhipster/blob/master/generators/server/templates/src/main/java/package/web/rest/util/PaginationUtil.java.ejs), but it seems that it is a deprecated use.

For more information I found this good article: https://specs.openstack.org/openstack/api-wg/guidelines/headers.html

If it is decided to change the naming of header variables, since this is a breacking changes this should be considered in v5.

PS: If you do not think that it is the correct place to discuss it (and the proper way), please consider to close it or contact me to open in other place.

Thanks
@DanielFran

[jdubois]

The current code is basically what I was doing for myself a few years ago, and that was never discussed/analyzed since that time. I never meant to do some sort of "standard", at that time JHipster was my own little pet project, I didn't think people would use it.
So yes we should discuss this, and at least have some kind of document like the OpenStack API guidelines you refer to, so people understand better our choices and design.

[jdubois]

As we are approaching JHipster v5 and migrating those will take time, maybe we should cancel this, and reconsider it for JHipster v6?

[gmarziou]

I read the links and frankly I don't think it's very important for us.
For instance, both Angular and Spring Security use X-XSRF-TOKEN header name and I don't think they will change anytime soon but maybe this is a de-facto standard.

[DanielFran]

@jdubois no problem, let's wait for next major release.

@gmarziou , I agree it is a choice but maybe just consider to document this?

[gmarziou]

@DanielFran yes documenting our headers is a good idea

[jdubois]

As there has been no activity on this for one month, and basically we don't have the time, I'm closing this.
It would be very interesting to study this topic, but there is just not enough time to do everything.