API 버전에 관련한 명칭 개선 제안
현재 Toss Payments API 문서에서는 다음 두 가지가 모두 “API 버전”이라는 동일한 용어로 불리고 있어, 개발자분들 사이에서 혼동이 발생하는 사례가 늘어나고 있습니다.
- api.tosspayments.com/v1, /v2 등 엔드포인트 URL 상의 버전
- 개발자센터에서 설정하는 요청/응답 전문(스펙) 버전
두 개념이 성격상 다름에도 불구하고 같은 이름으로 표기되다 보니, 실제 개발 과정에서 헷갈리는 경우가 잦습니다.
이를 방지하기 위해 문서에서는 아래와 같이 용어를 구분해 표기하는 것을 제안드립니다.
- API 버전: api.tosspayments.com/v1, /v2 등 엔드포인트 URL에 포함된 버전을 지칭
- 전문 버전: 개발자센터에서 설정하는 요청/응답 전문(스펙) 버전을 지칭
이렇게 명확히 구분하면, 외부 개발자들이 “엔드포인트 버전”과 “전문 스펙 버전”을 혼동하지 않고 이해할 수 있을 것으로 기대됩니다.
- api.tosspayments.com/v1, /v2 등 엔드포인트 URL 상의 버전
- 개발자센터에서 설정하는 요청/응답 전문(스펙) 버전
두 개념이 성격상 다름에도 불구하고 같은 이름으로 표기되다 보니, 실제 개발 과정에서 헷갈리는 경우가 잦습니다.
이를 방지하기 위해 문서에서는 아래와 같이 용어를 구분해 표기하는 것을 제안드립니다.
- API 버전: api.tosspayments.com/v1, /v2 등 엔드포인트 URL에 포함된 버전을 지칭
- 전문 버전: 개발자센터에서 설정하는 요청/응답 전문(스펙) 버전을 지칭
이렇게 명확히 구분하면, 외부 개발자들이 “엔드포인트 버전”과 “전문 스펙 버전”을 혼동하지 않고 이해할 수 있을 것으로 기대됩니다.
