코드닭 2024. 5. 8. 20:34

API

다른 소프트웨어 응용 프로그램이 특정 기능을 사용할 수 있도록 허용하거나 데이터에 접근할 수 있도록 하는 규약이나 도구 모음


REST API

HTTP 프로토콜을 기반으로 하는 API1. Resource(자원) : URI 를 통해 나타낸다 (/ribrary 같은 식으로)2. Verb(행위) : HTTP Method 를 통해 나타핸다 (/GET , /POST 등)3. 데이터 표현 : JSON, XML 을 주로 사용한다


REST URI 디자인 하기

  • URI는 명사, 소문자, 복수형을 사용하도록 한기
  • / 로 계층관계를 표현하기
  • URI의 마지막에는 / 를 표현하지 않기
  • 언더바( _ ) 가 아닌 하이픈( - ) 을 사용하기
  • 특정 Resource 를 가져올때는 그 해당하는 id 를 포함해서 표현하기
  • Path Variable 활용 : 페이징(Paging), 필터링(Filtering), 정렬(Sorting), 검색(Searching)을 통해 정보를 가져올시 /posts?page=12 , /posts?order=latest 처럼 활용한다