개발 일반

REST API 생성 규칙

민초부 2020. 10. 17. 16:16
반응형

요즘 거의 API 담당으로 생성하고 있는데 체크해야 할 사항 정리할겸 남긴다. 

  • 후행 슬래쉬는 포함되지 않아야 한다. (마지막이 '/'로 끝나면 안 된다.)
  • 계층 관계를 나타낼 땐 '/'로 구분한다. 
    • Ex: ID값이 52인 게시판의 게시물이면 ~~~/board/52로 작성한다.
  • 가독성을 위해 하이픈(-)을 사용한다. 
    • 이건 나도 몰랐던 거.. 그냥 습관적으로 underbar로 써서 사용했는데 4번째 규칙이 Underbar 사용 금지임 ㅋ
  • underbar ( _ ) 사용 금지 
    • 브라우저 상에서 URL을 보여줄 때 클릭 가능하다는 뜻으로 underlined 처리를 할 경우가 있는데 이 때 혼란을 방지하기 위해 underbar는 지양한다. 
  • 소문자를 사용하도록 한다.
  • 파일 확장자가 들어가지 않도록 한다. 
  • 명사에 대한 단수/복수 처리는 단순유지 규칙을 위해 일반적으로는 복수형태로 사용하고 있다. 
반응형