api-middleware

Sumor Cloud의 도구입니다.
더 많은 문서

API 미들웨어는 Node.JS를 위한 미들웨어입니다.
함수를 API로 쉽게 노출하고 매개변수를 유효성 검사할 수 있습니다.

설치

npm i @sumor/api-middleware --save

전제 조건

Node.JS 버전

Node.JS 버전 18.x 이상이 필요합니다.

Node.JS ES 모듈 필요

이 패키지는 ES 모듈로 작성되었기 때문에, package.json 파일에서 다음 코드를 변경해주세요:

{
  "type": "module"
}

사용법

기본 사용법

1. 프로젝트 폴더 api에 plus.js라는 파일을 추가하세요.

export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

2. [선택 사항] 프로젝트 폴더 api에 plus.json이라는 파일을 추가하세요.

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "매개변수 a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "매개변수 b",
      "type": "number"
    }
  }
}

3. index.js 파일에 다음 코드를 추가하세요.

import express from 'express'
import apiMiddleware from '@sumor/api-middleware'

const app = express()
apiMiddleware(app, process.cwd() + '/api')

app.listen(3000, () => {
  console.log('서버가 http://localhost:3000 에서 실행 중입니다.')
})

4. index.js 실행

node index.js

매개변수 규칙

매개변수에 규칙을 적용하는 예시는 아래를 참조하세요.

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "매개변수 a",
      "type": "number",
      "length": 3,
      "rule": [
        {
          "code": "GREATER_THAN_0",
          "expression": "^[1-9][0-9]*$",
          "message": "0보다 커야 합니다"
        }
      ],
      "i18n": {
        "zh": {
          "GREATER_THAN_0": "0보다 커야 함"
        }
      }
    },
    "b": {
      "name": "매개변수 b",
      "type": "number"
    }
  }
}

더 많은 사용법은 Validator를 참조하세요.

context

data

요청에 전달된 모든 매개변수가 포함되어 있습니다.

파일 업로드는 아래 객체처럼 구문 분석됩니다:

• name : 업로드된 파일 이름
• size : 업로드된 파일 크기(바이트)
• mime : 업로드된 파일 MIME 타입(예: image/png)
• encoding : 업로드된 파일 인코딩(예: 7bit)
• path : 업로드된 파일 경로

exposeApis

노출된 모든 API가 포함되어 있습니다.