[ WIL ] ( Week 4 주차) Restful API, package.json

이번 4주 차의 WIL의 주제는, Restful API, package.json이 WIL주제였다. 

Restful API에 대해서는 이미 이전 주차에 정리하면서 추가로 정리한 내용이 있어서 packge.json를 추가로 공부한 내용과 함께 올렸다! 

---

 

 

Restful API

2023.08.27 - [3. Node.js] - [ Node.js 입문주차 2 (2-0)] REST API, RESTful

[ Node.js 입문주차2 (2-0)] REST API, RESTful

 

---

 

package.json 

pack.json은 Node.js 프로젝트의 데이터를 저장하는 파일이다.

프로젝트의 정보, 모듈, 패키지 등을 정의하고, 의존하는 패키지의 버전 정보를 명시한다.  

pack.json 파일은 프로젝트의 루트 디렉토리에 위치하고, repository라는 속성을 통해 소스 코드가 저장된 곳을 지정할 수 있다.

 

---

 

package.json 파일의 구성은?

 

메타데이터 속성 식별: 기본적으로 프로젝트 이름, 모듈의 현재 버전, 라이선스, 프로젝트 작성자, 프로젝트에 대한 설명 등과 같은 모듈/프로젝트를 식별하는 속성으로 구성됩니다.

기능적 메타데이터 속성: 이름에서 알 수 있듯이 모듈의 진입 / 시작점, 프로젝트의 종속성, 사용 중인 스크립트, 노드 프로젝트의 저장소 링크 등과 같은 프로젝트 / 모듈의 기능적 값 / 속성으로 구성됩니다.

 

---

 

package.json 파일 사용

npm init 사용 

npm init

파일에 직접 쓰기 : 필요한 모든 정보를 파일에 직접 쓸 수 있으며 노드 프로젝트에 포함시킬 수 있습니다

 

---

 

package.json 예시

{
  "name": "GeeksForGeeks",
  "version": "1.0.0",
  "description": "GeeksForGeeks",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "node start.js",
  },
  "engines": {
    "node": ">=7.6.0",
    "npm": ">=4.1.2"
  },
  "author": "GeeksForGeeks",
  "license": "ISC",
  "dependencies": {
    "body-parser": "^1.17.1",
    "express": "^4.15.2",
    "express-validator": "^3.1.2",
    "mongoose": "^4.8.7",
    "nodemon": "^1.14.12",
  },
  "devDependencies": {},
  "repository": {
    "type": "git",
    "url": "https://github.com/gfg/gfg.git" //sample git repo url
  },
  "bugs": {
    "url": "https://github.com/gfg/gfg/issues"
  },
  "homepage": "https://github.com/gfg/gfg#readme"
}

예시 :

name: 프로그램/프로젝트의 이름

version: 프로그램의 버전입니다. 버전은 의미 체계 버전 관리 규칙을 따라야 한다.

description: 프로그램에 대한 설명, 응용 프로그램의 목적, React, MongoDB 등과 같이 사용되는 기술

main: 앱의 진입점/시작점입니다. 응용 프로그램이 시작될 때 트리거되는 응용 프로그램의 기본 파일을 지정합니다. 응용 프로그램은 npm start 사용하여 시작할 수 있다.

scripts: 제대로 실행하기 위해 응용 프로그램에 포함되어야 하는 스크립트.

engines: 사용된 노드 및 npm의 버전입니다. 이러한 버전은 애플리케이션이  google-cloud과 같은 클라우드에 배포되는 경우에 지정된다.

keywords: 응용 프로그램을 특징짓는 문자열 배열을 지정한다.

author: 이름, 이메일 및 기타 저자 관련 정보와 같은 저자에 대한 정보로 구성됩니다.

license: 응용 프로그램에서 확인하는 라이선스는 key-value pair 언급되어 있습니다. 

dependencies: 설치된 타사 패키지 또는 모듈

npm: npm 지정

devDependencies: 애플리케이션의 개발 부분에서만 사용되는 종속성은 이곳에서 지정됩니다. 

repository: 응용 프로그램의 코드가 있는 저장소의 유형 및 URL에 대한 정보가 포함되어 있습니다.

bugs:  버그를 보고해야 하는 URL과 이메일이 이곳에 언급되어 있습니다.

 

---

 

 

참조: URL : Node.js package.json - GeeksforGeeks

Node.js package.json - GeeksforGeeks

 

 

---

 

요즘 시간이 너무 빨리간다.

부지런히 뭔가 해야지 하면서도 많이 놓치고 있는 것 같다..!

 

잘.. 아니.. 열심히 잘... 해야지.. 파이팅.. 나..