Skip to content

REST API

Junyong Moon edited this page Dec 21, 2023 · 2 revisions

REST API 규칙

  1. URI 마지막에 슬래시(/)를 붙이지 않는다.
  2. 관계를 나타내기 위해 슬래시(/)를 사용한다.
  3. 하이픈(-)를 사용하며, 언더바(_)를 사용하지 않는다.
  4. 소문자를 선호하며 명사를 사용한다.
  5. URI에 파일 확장자를 사용하지 않는다.
  6. 복수형을 사용하기
  7. 일부 URL가 겹치는 경우 동사를 허용한다. (CRUD 제외한 동사 허용)

공통

  • Controller 클래스 위에 @RequestMapping(/api/{테이블명 복수형}) 추가한다.
    • ex) 유저(사용자) 컨트롤러인 경우 `@RequestMapping(/api/users)
  • 맨 앞에는 /api로 시작한다.

Clone this wiki locally