API v3

2021-09-14

목차

1. v2 와의 차이점

2. 호환성 및 유지보수

3. 기본 형식

4. 기타

API 자세히 보기 : https://docs.lrl.kr

• URL 단축 v3 : https://lrl.kr/bbs/board.php?bo_table=docs&wr_id=6
• URL 만들기 v3 : https://lrl.kr/bbs/board.php?bo_table=docs&wr_id=7 
• URL 안전검사 v3 : https://lrl.kr/bbs/board.php?bo_table=docs&wr_id=8 

1. v2 와의 차이점

v2 는 GET 과 POST 방식을 모두 지원했으며,

다양한 아웃풋 ( TXT, JSON, XML ) 을 지원했습니다.

v3 API 는 POST 방식만 지원하며

인풋, 아웃풋 데이터를 JSON 형식으로 통일하였습니다.

• v2 대비 30% 이상 빠른 지연시간
• TTFB ( Text To First Byte ) 늘어지는 오류 수정
• 코드 간소화
• 오류 디버깅 및 상태코드

API 문서에서 예제 미리보기가 추가되었습니다.

서버에 적용하기 전에 미리 어떻게 작동하는지 확인가능합니다.

2. 호환성 및 유지보수

v2 와의 호환성이 사라지며, 코드를 새로 작성하셔야 합니다.

여타 버전의 API 처럼 v2 는 레거시 상태로 지원됩니다. 다만, 최신 API 를 이용하는것을 권장합니다.

v3 는 LTS ( Long Time Support ) 로 장시간 지원하며, 새로운 API 업데이트 시

JSON 의 message 항목 데이터로 알려줍니다.

3. 기본 형식

REST 향기가 나게 https://api.lrl.kr/v3/short 처럼 끝자리 슬래시 없이 사용합니다.

전송 메소드는 POST, 데이터 형식은 JSON 입니다.

4. 기타

v2 API를 사용하다 보니 API가 영 체계적이지 않다는 것을 알았습니다.

3가지의 아웃풋을 지원하고 두가지의 전송방식을 지원하다 보니 오류가 발생해도 개발자가 알기 힘들었으며

코드가 지저분했고, 세가지 아웃풋을 모두 지원해야 하기 때문에 비효율적이었습니다.

따라서 최근 REST API 를 공부하던 중 REST 개념을 일부 참조하여 v3 를 만들었습니다.

API 사용 중 오류 발생 시 지나치지 마시고 신고 및 문의 게시판에 꼭 글을 남겨주세요. 

회원이 아니더라도 글 작성이 가능하며, 확인 즉시 신속히 오류 처리하겠습니다.