api-middleware

Sumor Cloud 도구입니다.
더 많은 문서
API Middleware는 Node.JS를 위한 미들웨어입니다.
기능을 쉽게 API로 노출시키고 매개변수를 유효성 검사할 수 있습니다.

설치

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": "파라미터 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

context

data

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

파일 업로드는 다음과 같은 객체로 구문 분석됩니다:

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

exposeApis

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