1, 프로토콜
API 와 사용자 간의 통신 프로토콜은 항상 HTTPs 프로토콜을 사용합니다.
2. 도메인 이름
개인 도메인 이름으로 API 를 배포해야 합니다.
API 가 비교적 간단하고 더 이상 확장되지 않을 것이라고 확신하면 주 도메인 이름 아래에 두는 것을 고려해 볼 수 있습니다.
3. 버전 관리
API 의 버전 번호를 URL 에 넣어야 합니다.
또 다른 방법은 버전 번호를 HTTP 헤더 정보에 넣는 것이지만 URL 을 넣는 것보다 편리하고 직관적입니다. Github 는 이런 방법을 채택했다.
4, 경로 (끝점)
경로 ("끝점" 이라고도 함) 는 API 의 특정 URL 을 나타냅니다.
RESTful 스키마에서 각 URL 은 리소스를 나타내므로 URL 에는 동사가 없어야 하고 명사만 있을 수 있으며 사용되는 명사는 종종 데이터베이스의 테이블 이름에 해당합니다. 일반적으로 데이터베이스의 테이블은 유사한 레코드의 "집합" 이므로 API 의 명사도 복수여야 합니다.
예를 들어 다양한 동물과 직원에 대한 정보를 포함하여 동물원에 대한 정보를 제공하는 API 가 있는 경우 경로를 다음과 같이 설계해야 합니다.