사용자 정의 HTTP 헤더 : 명명 규칙

여러 사용자들이 API에서 보내는 요청의 HTTP 헤더나, 받는 응답과 관련하여 계정과 관련된 데이터를 포함해 달라고 요청했습니다.
커스텀 HTTP 헤더를 추가하는 일반적인 규칙은 이름, 형식 등에 대해 어떻게 정의되어 있을까요?

또한, 웹 상에서 마주친 이러한 기능의 스마트한 사용 예를 자유롭게 공유해주셔도 됩니다. 우리는 가장 좋은 방법을 타깃으로 구현하려고 합니다 :)

답변 1

3. 새로운 매개변수 생성자를 위한 권장사항

...

3. X- 또는 유사한 구조로 시작하는 매개변수 이름을 사용해서는 안 됩니다.

4. 프로토콜 디자이너를 위한 권장사항

...

4. X- 접두사 또는 유사한 구조를 가진 매개변수가 등록되지 않아야 합니다.

   
   



5. X- 접두사나 유사한 구조를 가진 매개변수가 비표준화로 이해되어야 한다고 명시해서는 안 됩니다.

   
   



6. X- 접두사나 유사한 구조가 없는 매개변수는 표준화로 이해되어야 한다고 명시해서는 안 됩니다.

   
   

SHOULD NOT (discouraged)와 MUST NOT (forbidden)는 동일하지 않음을 유념하세요. 또한, those keywords에 대한 다른 사양인 RFC 2119도 참조하세요. 다시 말해, X- 접두사 헤더를 계속 사용할 수 있지만, 이제 공식적으로 권장되지 않으며, 공개 표준인 것처럼 문서화해서는 결코 안 됩니다.

요약:

• 공식 권장은 X- 접두사 없이 이름을 분명하게 지정하는 것입니다.


• X- 접두사 헤더를 계속 사용할 수 있지만, 이제 공식적으로 권장되지 않으며, 문서화해서는 결코 안 됩니다.

답변 2

Custom HTTP 헤더 : 네이밍 관례
웹 개발에서 HTTP 헤더는 통신 프로토콜의 일부로, 클라이언트와 서버 간의 데이터 교환에 중요한 역할을 합니다. 이러한 헤더는 서버로 보내는 요청(request)과 서버로부터 받는 응답(response)에 대한 정보를 포함하고 있습니다. 헤더에는 다양한 필드들이 있으며, 필드에는 이름과 값을 가진 속성이 정의되어 있습니다. 이 속성의 이름을 정하거든 나름대로 고민을 해야 할 필요가 있습니다.
그러나 SEO를 고려할 때, 개인 맞춤 헤더에도 특정 네이밍 관례가 있습니다. 검색 엔진 최적화를 위해 HTTP 헤더를 적절하게 사용하는 것이 중요하며, 네이밍 관례는 이를 도와줄 수 있습니다.
첫째, 각 헤더의 이름은 의미 있고 명확해야 합니다. 검색 엔진은 웹 사이트의 콘텐츠를 크롤링하고 색인하기 위해 헤더의 데이터를 분석합니다. 따라서 각 헤더의 이름은 해당 헤더가 가리키는 정보와 관련이 있어야 합니다. 예를 들어, X-SEO-Keywords라는 헤더는 해당 페이지의 주요 키워드를 제공하는 데 사용될 수 있습니다.
둘째, 혼동을 방지하기 위해 헤더의 이름은 명확하고 일관되게 작성되어야 합니다. 서로 다른 헤더들 간에 이름이 유사하거나 혼동을 일으킬 수 있는 식별자를 사용하는 것은 바람직하지 않습니다. 검색 엔진은 헤더의 이름을 분석하여 해당 정보의 의미를 해석하므로, 명확하고 일관된 네이밍을 사용하면 혼동을 최소화할 수 있습니다.
셋째, 헤더의 이름은 가능한 한 짧고 간결해야 합니다. 검색 엔진은 헤더의 길이를 고려하여 데이터를 처리하므로, 긴 이름을 사용하면 헤더와 함께 전송되는 데이터 양이 증가할 수 있습니다. 따라서 간결한 이름을 사용하여 데이터 크기를 최소화하는 것이 좋습니다.
마지막으로, 네이밍 관례에 따라 표준 헤더와 구별되게 만들어야 합니다. 기존에 존재하는 표준 헤더와 근본적으로 다른 사용자 정의 헤더는 X- 접두사를 사용하여 네이밍을 할 수 있습니다. 이를 통해 검색 엔진은 표준 헤더와 사용자 정의 헤더를 구별하고, 이에 따라 적절한 처리를 할 수 있습니다.
효과적인 검색 엔진 최적화를 위해 네이밍 관례를 잘 따르는 개인 맞춤 헤더를 사용하는 것이 중요합니다. 각 헤더의 이름은 의미 있고 명확하며, 헤더 간에 혼동을 방지하기 위해 일관된 네이밍을 사용해야 합니다. 또한, 길이를 최소화하고 기존 표준 헤더와 구별되게 만드는 것이 좋습니다. 이러한 네이밍 관례는 검색 엔진이 웹 사이트를 제대로 인식하고 해석할 수 있도록 도와줍니다.