Restful API

이산·2022년 4월 10일
0

기술블로그

목록 보기
19/42

API 시스템을 구현하기 위한 아키텍처 중에 가장 널리 사용되는 형식이 REST이다.

내가 가지고 있는 장고에서 정의만 내려도 api 형태가 이루어지고 기능 구현이 일어난다. 간단하고 보기 쉽고 직관적이다.

HTTP URI라고 보이는 거대한 링크처럼 보이는 내용을 다루는대 내가 원하는 목적어나 동사, 행하는 동작이나 목적을 나타내며 누구든지 어떠한 url 인지 알 수 있게 된다.

장점: 잘 나타낼 수있다. 쉽게 이해할 수 있음. 쉽게 목적이 이해된다

단점: 표준규약이 없어서 안티패턴으로 작성되는 경우가 흔하다.


설계규칙

  • 명사 및 복수 사용

  • http method 및 불필요한 동사를 포함하지 않는다.

  • 유저에서 그 유저의 프로필 사진을 보고 싶을 경우

  • 파일 확장자를 포함시키지 않는다.


Path Parameter


Query Parameter

보통 통신에서 가장 기초적인 것은 order 형태로 보낸다.

Pagination은 더보기 or 무한스크롤 등을 위해서 쓰인다.
이것을 사용하지 않는다면 수많은 데이터를 다 끌고 오게 될 것이고, 데이터 이동이 비효율적일 것이다. offset 0 시작 limit 100이 끝 번호(한 페이지당)

특정한 str만으로 검색하고 싶을 경우 Searching 형태를 사용한다.


Status Code

profile
백엔드 개발자입니다.

0개의 댓글