sg-openapi-validator

2.0.18 • Public • Published

sg-openapi-validator

openapi 3.0용 validator입니다. 스키마를 설정하면 요청값이 올바른 요청인지 schema를 기준으로 판단합니다.

Installation

npm install --save sg-openapi-validator

Example

const OpenApiValidator = require('sg-openapi-validator')
const app = require('express')()

app.use(OpenApiValidator.bindSpec(schema)) // openapi 3.0 schema 전체 입력 (json)
app.use(OpenApiValidator.validator('apis')) // api prefix

(res, res, next) => {
	
	// {a}/{b}/c 의 형식을 :a/:b/c의 형식으로 바꿔준다.
	req.convertOpenAPIUrlToExpressUrl('open api url')
	
	// url, method를 이용해서 req에 들어있는 파라미터 벨리데이션
    req.validateParameters(url, 'post')
    
    // url, method를 이용해서 req에 들어있는 body 밸리데이션
    req.validateRequestBody(url, 'post')
}

Package Sidebar

Install

npm i sg-openapi-validator

Weekly Downloads

1

Version

2.0.18

License

ISC

Unpacked Size

27.1 kB

Total Files

5

Last publish

Collaborators

  • hwaranglee
  • sngsng
  • piorio0919
  • kspark