API 설계하기 (url, method, spec 문서화하기)

minjung·2022년 11월 26일
0

ect.

목록 보기
2/4

API란?

AWS | API란 무엇입니까?

API는 Application Programming Interface(애플리케이션 프로그램 인터페이스)의 줄임말이다.
애플리케이션은 고유한 기능을 가진 모든 소프트웨어를, 인터페이스는 두 애플리케이션 간의 서비스 계약이라고 할 수 있다.



API 설계하기

API가 두 시스템(어플리케이션)이 상호작용 할 수 있게 하는 프로토콜의 총 집합이라면,
ENDPOINT는 API가 서버에서 리소스에 접근할 수 있도록 가능하게 하는 URL이라 할 수 있겠다.

[출처] API 와 Endpoint ? (둘 다 정확히 알고 있다면 안봐도 되는 글) | [작성자 토찌]

endpoint

api를 설계할 때는 endpoint urlhttp method, 해당 api들이 어떤 기능을 하게될 지를 미리 정해서 문서화를 한다. 그리고 그것을 토대로 개발을 진행한다.

크게 viewapi로 종류를 나눌 수 있다.


  • view

게시판 화면 url에서 board로 하지 않고 articles로 한 이유는, api와의 일관성을 위함이다.
게시판 리스트를 보여주는 기능과 대칭점에 있는, 실제로 데이터를 보내줄 api url과 일관성있게 만들기 위한 것이다.
게시글에는 article을 사용하고 게시판에는 articles를 사용한다.


  • api

api에는 모든 루트를 /api로 시작하는 규칙을 줬다.


api spec

'어떤 데이터가 api와 함께 전달될까?' 를 생각해본다.

0개의 댓글