@sumor/api-middleware

api-middleware

Sumor Cloud 툴.
더 많은 문서
API Middleware는 Node.JS용 미들웨어입니다.
함수를 쉽게 노출하고 매개변수를 유효성 검사할 수 있습니다.

CI
Test
Coverage
Audit

설치

npm i @sumor/api-middleware --save

필수 조건

Node.JS 버전

Node.JS 버전 16.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()
apiMiddleware(app, process.cwd() + '/api')

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000')
})
4. index.js 실행
node index.js