5. json-server

Hyun·2023년 5월 9일
0

nodejs

목록 보기
5/19
post-thumbnail

1. json-server 이해하기

학교 팀플이나 프로젝트를 하면서 느끼는 것이지만 가장 중요한 것은 효율적인 시간 사용과 프로젝트에 투입된 멤버들 간의 소통인 것 같다.
소통이 단순히 의사 전달을 의미하는 것이 아니라 프로젝트 내에서 역할을 효율적으로 수행하기 위해서 낭비되는 시간이 없도록 하는 것이다.

보통 Front-End와 Back-End가 서로 협력해 하나의 애플리케이션을 개발 할 것인데, 프론트엔드 입장에서 백엔드 개발자가 서버 프로그램을 늦게 개발하여 서버 프로그램이 개발될 때까지 프론트엔드 개발을 못하고 대기하면서 낭비되는 시간이 발생 할 수도 있다.
반대로 백엔드 개발자 입장에서는 구현한 API가 프론트엔드 개발자가 호출해서 사용하고 이상이 없는지 검증해 주지 않으면 클라이언트와 서버 간의 정상적인 데이터 통신이 정상적인지 확인 할 수가 없다.

이를 방지하기 위해 json-server를 사용하면 Node.js로 웹 서버를 구축하는 백엔드 개발자뿐만 아니라 프론트엔드 개발자가 아직 웹 서버가 구축이 되지 않았을대 프론트엔드 개발을 진행할 수 있도록 도와준다.

2. REST API

API는 애플리케이션을 구축하고 통합하기 위한 프로토콜 세트이다.
API를 이용하면 이게 어떻게 구현되었는지는 몰라도 애플리케이션이 서로 커뮤니케이션이 가능하고, 개발을 간소화하여 시간과 비용을 절약할 수 있다.

REST는 자원을 이름으로 구분하여 해당 자원의 상태(전송되는 데이터)를 주고 받는 모든 것을 의미한다. 보통 JSON 형식으로 주고 받는다.
HTTP + JSON 형태로 REST API를 정의하면 웹,안드로이드,ios 같은 플랫폼이나 자바나 파이썬 같은 언어에 종속받지 않고, HTTP와 JSON을 사용할 수 있는 모든 플랫폼에서 사용이 가능하다는 장점이 있다.

규칙

1) 소문자로 표현

2) 언더바(_) 대신 하이픈(-)을 사용한다.

3) 마지막에 슬래시(/)를 포함하지 않는다.

4) 행위를 포함하지 않는다.

5) 파일 확장자는 URL에 포함시키지 않는다.

6) 전달하고자 하는 명사를 사용하되, 컨트롤 자원을 의미하는 경우 예외적으로 동사를 사용한다.

7) URI에 작성되는 영어를 복수형으로 작성한다.

3. json - server 설치

1. npm install -g json-server (만약 에러가 발생하시면 sudo 붙여서 해보세요)

2. json 파일 생성
   1) 프로젝트 폴더 안에 json 파일을 저장할 폴더를 만든다.
   2) 그 폴더 안에 db.json 파일을 만든다.
   3) json 데이터를 저장한다.

코드

3. json-server 실행
   1) json-server 폴더로 이동
   2) json-server --watch db.json 실행

실행결과

4. 결론

db.json에는 개발을 위해 필요한 데이터 리소스를 등록해서 사용하면 된다.
웹 서버 구축 후 프론트엔드 개발자가 호출할 리소스 URL과 동일한 형태로 등록하면, 백엔드 개발자가 실제 웹 서버 구축을 완료해도 프론트엔드 개발자가 이미 구현해 놓은 프로그램 코드를 거의 수정할 일이 없이 그대로 사용할 수 있기 때문에 구축 시간을 단축시킬 수 있다.

0개의 댓글