1.0.2 • Published 2 years ago

@blued-core-oversea/http-server v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

基于 routing-controller 的简易封装,抽出了一些复用的逻辑。

npx install-peerdeps @blued-core/http-server

使用方式

import { createServer } from '@blued-core/http-server'

createServer({
  logPath: './log',
  exceptionReportUrl: 'sentry.xxx.com',
  performanceConfig: {
    host: '0.0.0.1',
    port: 12345,
    group: 'test',
    project: 'test-project'
  },
  port: 1234
})

// 具体的 router 实现

import { JsonController, Get } from '@blued-core/http-server'

@JsonController('/test')
export default class {
  @Get('/patha')
  get () {
    return 'Hello World'
  }
}

// curl http://127.0.0.1:1234/test/patha

如果请求 Header 携带 Content-Type: application/json 则会主动拼接参数,类似
{ code: 200, data: 'Hello World' }

主要文档基于:http-server-base

额外提供的参数

optiontypedefaultdesc
logPathstring-设置 log 输出的路径
exceptionReportUrlstring-设置异常监控上报的路径
performanceConfigObject-设置性能监控上报的配置

performanceConfig 具体配置

optiontypedesc
hoststring配置的 IP
portnumber端口号
groupstring上报数据所属分组
projectstring上报数据所属项目