Sumor Cloud 도구입니다.
더 많은 문서
API Middleware는 Node.JS용 미들웨어입니다. 함수를 쉽게 API에 노출하고 매개변수를 유효성 검사할 수 있습니다.
npm i @sumor/api-middleware --save
Node.JS 버전 18.x 이상이 필요합니다.
이 패키지는 ES 모듈로 작성되었으므로,
package.json
파일에서 다음 코드를 변경해주세요:
{
"type": "module"
}
api
에 plus.js
라는 파일을 추가합니다.export default async (context, req, res) => {
const { data } = context
const { a, b } = data
return a + b
}
api
에 plus.json
이라는 구성 파일을 추가합니다.{
"name": "plus",
"parameters": {
"a": {
"name": "parameter a",
"type": "number",
"length": 3
},
"b": {
"name": "parameter b",
"type": "number"
}
}
}
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에서 실행 중입니다')
})
index.js
를 실행합니다.node index.js
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
를 엽니다.
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
로 대체하세요.
name: plus
parameters:
a:
name: parameter a
type: number
length: 3
b:
name: parameter b
type: number
구성 파일에 js 함수를 지원하려면 config.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를 참조하세요.
요청에 전달된 모든 매개변수를 포함합니다.
파일 업로드는 다음과 같은 객체로 구문 분석됩니다:
name
: 업로드된 파일 이름size
: 업로드된 파일 크기(바이트)mime
: 업로드된 파일 MIME 유형(예: image/png)encoding
: 업로드된 파일 인코딩(예: 7bit)path
: 업로드된 파일 경로노출된 모든 API를 포함합니다.