relaese 2.0.2 🎲

Documentation Services

Enable document service

fireCatRouter.enableDocument()

Custom document service path

fireCatRouter.enableDocument('/document')

custom document description

fireCatRouter.enableDocument('/document', {
   title: 'Interface Documentation',
   description: 'This is the interface document',
   date: '2022-05-20',
   version: '1.0.0'
})

ApiDescription

ApiDescription(des: string)

Describe the request and render it into the final document

class MyController extends FireCatController {
   @Post('hello')
   @ApiDescription('This is a request')
   hello(ctx: Context) {
     ctx.body = "hello world"
   }
}