소개 

이 기사에서는 호스팅 제공 업체에서 호스팅 할 필요 없이 코딩 없이 인터넷에서 액세스 할 수 있도록 자체 REST API 서버를 쉽게 만드는 방법을 살펴 봅니다.

그럼 시작하겠습니다

로컬 환경 설정 

• 이름이 users-api-server 인 새 폴더를 만듭니다.
• 명령 줄에서 폴더 내부를 탐색하고 다음 명령을 실행합니다.

npm init -y

그러면 프로젝트 내에 package.json 파일이 생성됩니다.

• 다음 명령을 실행하여 json-server npm 패키지를 설치합니다.

npm install json-server

• 코드를 GitHub 저장소로 푸시하는 동안 node_modules 폴더가 GitHub로 푸시 되지 않도록 내부에 node_modules 항목이 포함 된 .gitignore라는 이름의 새 파일을 만듭니다.
• db.json이라는 이름으로 새 파일을 만들고 그 안에 다음 내용을 추가합니다.

{
  "users": [
    {
      "id": 1,
      "name": "David",
      "age": 30
    },
    {
      "name": "John",
      "id": 2,
      "age": 40
    }
  ]
}

• package.json 파일을 열고 그 안에 스크립트 섹션을 추가합니다.

"scripts": {
  "start": "json-server db.json"
}

• 이제 터미널에서 npm start 명령을 실행하여 애플리케이션을 시작합니다.
• http : // localhost : 3000 /에서 액세스하면 다음 화면이 표시됩니다.

리소스 섹션에서 /users 링크를 클릭하면 다음 화면이 표시됩니다.

팁 : 위에 표시된대로 멋진 형식의 JSON 출력을 얻으려면 JSON Formatter 브라우저 확장을 설치하십시오.

• 축하합니다! 한 줄의 코드를 작성하지 않고 자신 만의 REST API 서버를 작성했습니다.
• 이제 우리는 자체 API에 대한 GET, POST, PUT, PATCH 및 DELETE API 호출을 할 수 있습니다.

모든 사용자를 얻기 위해 Get API 요청 만들기 

새 사용자 추가를 위한 POST API 요청 만들기 

사용자 업데이트를 위한 PUT API 요청 만들기 

사용자 삭제를 위한 DELETE API 요청하기 

변경 사항 저장 

이제 애플리케이션에 대한 API 호출을 수행했습니다.

이러한 API 호출의 최종 결과를 저장하려면 키보드에서 s 키를 누르고 Enter 키를 누르면 터미널에서 볼 수 있듯이 변경 사항의 스냅 샷이 별도의 파일에 저장됩니다.

애플리케이션 배포 

json-server를 사용하는 애플리케이션을 배포하는 것은 매우 쉽습니다.

GitHub 리포지토리를 만들고 로컬 변경 사항을 해당 리포지토리에 푸시하고 브라우저에서 특정 URL로 액세스하면 됩니다.

다음 단계에 따라 수행하십시오.

이 URL로 이동하여 새 GitHub 저장소를 만듭니다.

원하는 저장소의 이름을 입력하고 공개 한 다음 저장소 생성 버튼을 클릭합니다.

• 다음 화면이 표시됩니다.

• git remote add라는 URL을 복사합니다.
• 이제 프로젝트에서 터미널을 열고 먼저 git init. (git init dot) 명령을 실행 한 다음 마지막 단계에서 복사 한 URL을 붙여 넣고 Enter 키를 누릅니다.

• 이 두 명령은 프로젝트를 git 저장소로 만들고 로컬 git 저장소를 GitHub로 지정합니다.
• 이제 다음 명령을 순서대로 실행하여 변경 사항을 GitHub에 푸시 할 수 있습니다.

1. git add --all .
2. git commit -m "your_commit_message"
3. git push origin master

• 변경 사항이 저장소에 푸시되면 https://my-json-server.typicode.com/your_github_username/your_repository_name (예 : https://my-json-server.typicode.com)으로 이동하여 json-server에 액세스 할 수 있습니다. / myogeshchavan97 / users-api

이제 누구나 API를 사용할 수 있도록 API를 웹에 라이브로 배포했습니다.

라이브 배포 

완전한 API 

Users API 

참고 : json-server를 라이브로 배포하려면 실제로 프로젝트에 db.json 파일 만 있으면 됩니다. package.json 파일 내에 json-server npm 패키지를 로컬로 설치할 필요가 없습니다.

라이브로 만들기 전에 API를 로컬에서 테스트 할 수 있도록 로컬에 설치했습니다.

json-server 사용의 장점은 https://my-json-server.typicode.com/ URL을 사용하여 API에 액세스 할 때 원본 db.json 파일을 변경하지 않는다는 것입니다. 따라서 각 사용자는 db.json API의 동일한 사본을 받게 됩니다.

json-server를 사용하여 로컬에서 테스트하는 경우에만 원본 db.json 파일이 수정됩니다.

json-server에 대해 자세히 알아 보려면 여기를 클릭하십시오.

결론 

보시다시피 프로젝트 폴더 내에 db.json 파일 만 생성하고 해당 파일에 JSON 객체 구조를 제공하면 호스팅 할 필요 없이 인터넷에서 라이브로 사용할 수 있는 자체 REST API 서버를 생성 할 수 있습니다.

이 애플리케이션의 전체 소스 코드는 여기에서 찾을 수 있습니다.