swagger

galenjs swagger document

Usage

install

pnpm install @galenjs/swagger

example

const buildSwaggerDocs = require('@galenjs/swagger')

const openApiInfo = {
  title: 'galenJs API document',
  version: 'v3',
  description: 'openApi 3.0 document',
  contact: {
    name: 'AlfieriChou',
    email: '[email protected]',
    url: 'https://github.com/AlfieriChou/galen/tree/master/packages/swagger'
  },
  license: {
    name: 'MIT',
    url: 'https://github.com/AlfieriChou/galen/blob/master/LICENSE'
  }
}

buildSwaggerDocs(openApiInfo, {
  schemas: ctx.jsonSchemas, remoteMethods: ctx.remoteMethods
})