RESTful API 가이드라인

유럽의 패션 플랫폼 회사인 Zalando의 RESTful API 가이드라인 문서입니다. PDF로 139쪽에 해당하는 긴 내용의 가이드라인입니다. 한 회사의 가이드라인이므로 모든 경우에 옳다고 할 수는 없겠지만, 특별한 규칙없이 REST API를 작성하고 계셨다면 기본적인 가이드라인을 잡는데에 도움이 될 것이라 생각합니다. 가이드라인이라서 안내만 하는 것으로 생각하실 수 있습니다만, 요구사항 준수 수준이라는 것이 있어서 MUST, MUST NOT 등의 키워드로 구분 해두었습니다. MUST중 몇가지 가이드라인 예시는 다음과 같습니다. * API First 원칙을 따릅니다. * OpenAPI를 사용하여 API 스펙을 제공 해야 합니다. * 영어를 사용하여 API를 작성 해야 합니다. * 시맨틱 버전 관리를 사용 해야 합니다. * API는 메타정보를 포함되어야 합니다. * 반드시 표준 데이터 형식을 사용해야 합니다. * 리소스 이름은 복수형이어야 합니다. * 액션을 API 명으로 사용해서는 안됩니다. 리소스에 대해 생각하세요. 잠깐 살펴봐도 꽤나 합리적인 원칙들이라는 생각이 들지 않으시나요? Zalando의 가이드를 참고해서 여러분의 팀의 자체 가이드를 만드는 것도 좋을 것 같습니다. https://opensource.zalando.com/restful-api-guidelines/