멋진 API를 만드는 3가지 비결

1. API에 링크를 사용하라

: 길이가 긴 정보에 대해서는 URL을 제공하여 가독성을 강화

{
 "id": "583",
 "name": "Jon Snow",
 ...,
 "father": "2342",
 "mother": "1243",
 "spouse": "4553",
  ...,
}

// 링크로 대체
{
 "id": "https://anapioficeandfire.com/api/characters/583",
 "name": "Jon Snow",
 ...,
 "father": "https://anapioficeandfire.com/api/characters/2342",
 "mother": "https://anapioficeandfire.com/api/characters/1243",
 "spouse": "https://anapioficeandfire.com/api/characters/4553",
 ...,
}

 

 

2. 쿼리 URL은 예측 가능해야 한다

- A: https://dogtrackercom/person/{personId}/dogs
- B: https://dogtrackercom/getPeopleFunction/{personId}/getAlldogs

: A와 같이 URL의 의미를 쉽게 유추할 수 있도록 해야한다

 

 

3. 필요한 것만 제공해야한다

: 필터링과 페이징을 제공하여 원하는 데이터만 가져올 수 있도록 해야한다

 

 

 

 

Reference

조서희 / 멋진 API를 만드는 3가지 비결 | 커리어리