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": "parameter a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

3. index.js 파일에 다음 코드 추가

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

const app = express()

await apiMiddleware(app, process.cwd() + '/api')

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

4. index.js 실행

node index.js

5. API 테스트

curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'

또는 브라우저로 http://localhost:3000/plus?a=1&b=2 열기

apiMiddleware 옵션

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

const app = express()

await apiMiddleware(app, process.cwd() + '/api', {
  prefix: '/api',
  prepare: async context => {
    // API 실행 전에 수행할 작업
  },
  finalize: async (context, result) => {
    // API 실행 후에 수행할 작업
  },
  exception: async (context, error) => {
    // 에러 처리
  }
})
app.listen(3000, () => {
  console.log('서버가 http://localhost:3000 에서 실행 중입니다.')
})

다양한 설정 파일 유형

yaml

plus.json 대신 plus.yml을 사용하여 설정 파일을 정의할 수 있습니다.

type은 number, string, boolean, array, object만 지원합니다.

name: plus
parameters:
  a:
    name: parameter a
    type: number
    length: 3
  b:
    name: parameter b
    type: number

config.js

설정 파일에서 js 함수를 지원하려면, plus.json 대신 plus.config.js 파일을 사용할 수 있습니다.

export default {
  name: 'plus',
  parameters: {
    a: {
      name: 'parameter a',
      type: 'number',
      length: 3
    },
    b: {
      name: 'parameter b',
      type: 'number',
      rule: [
        {
          code: 'TOO_BIG',
          message: 'b should be less than 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

매개변수 규칙

아래 예제를 참조하여 매개변수에 규칙을 적용할 수 있습니다.

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parameter a",
      "type": "number",
      "length": 3,
      "rule": [
        {
          "code": "GREATER_THAN_0",
          "expression": "^[1-9][0-9]*$",
          "message": "must be greater than 0"
        }
      ],
      "i18n": {
        "zh": {
          "GREATER_THAN_0": "必须大于0"
        }
      }
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

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

context

data

요청에 전달된 모든 매개변수를 포함

파일 업로드는 아래 객체로 구문 분석됨:

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

exposeApis

노출된 모든 API를 포함