2013-12-22 2 views
0

현재 REST API를 작성 중입니다.이 질문은 항상 팝업으로 보입니다.REST API 홈페이지에 무엇이 있어야합니까?

저는 항상 설명, 문서 링크, 서버 시간 등에 대한 빠른 링크를 추가했지만 API 문서로의 간단한 리디렉션이 더 좋을 것이라고 봅니다.

제 질문은 API의 루트 - '/'- 'homepage'로 받아 들여지는 표준이 무엇입니까?

나는 몇 구현에서 찾고 있었어요 :

  • 페이스 북 : 그냥의 오류가 있습니다; "지원되지 않는 GET 요청을."
  • Twitter : 실제 404 페이지를 보여줍니다.
  • StackOverflow : 빠른 "사용"페이지로 리디렉션합니다.

사람들을 보았을 때 모두가 다르게하고 있습니다.

큰 그림에서 이것은 약간의 중요성을 가지지 만, "RESTfull"방법 (있는 경우)이 무엇인지 알면 흥미로울 것입니다.

+0

홈페이지가 리소스입니까? 그렇다면 해당 리소스를 반환하십시오. 그렇지 않은 경우 404. 설명/매뉴얼/지침은 리소스로 간주되지 않으므로 API의 일부가 아니어야합니다. – DavidLin

답변

1

다른 사람들도 같은 질문을 가지고 있으며 자신이 발견 한 것처럼 모두가 자신의 방식대로하고 있습니다. 어떻게 든 표준화하기 위해이 방향으로 움직이기 때문에이 초안이 유용하다고 생각한다면 참조하십시오.

Home Documents for HTTP APIs 일명 JSON 홈.