koa-joi-router-docs
koa-joi-router-docs copied to clipboard
chuyik
A Swagger API Docs generator from koa-joi-router routes.
使用 Joi .required() 描述 query ``` // koa-joi-router setting publicRouter.route({ method: 'get', path: '/:ShopId/example', validate: { query: { phone: Joi.string().required(), }, }, handler: ctrl, }) ``` 生成 swagger json 不會正常標記...
Currently version 1.2.1 cant be used with joi 17.3.0 schemas. This would require an upgrade of chuyik/joi-to-swagger to support joi 17.3.0 or possibly a switch to Twipped/joi-to-swagger 5.1.0. I would...
I currently use koa-joi-router-docs for documenting APIs which use paths like `key=:key`. koa-joi-router works just fine with these routes, but the generated Swagger docs end up having the "=" replaced...
This is a really nice project. Any interest in moving it to the official [koajs](https://github.com/koajs) org where koa-joi-router lives?
Sometimes responses with codes 4XX contains some body. Content of error is rendered correctly, but it's described as success. Rendered docs:  Output rule in...
Hey! Thx for the lib, realy helping me out! Would be realy nice if the generated api have a x-codeSmaple' even if was just CURL would realle be helpfull, if...
I have nested routers , using common routers,... subRoutes.get('/other-routes', ... ); router.use('/base-route/', subRoutes.middleware()); I've tried to define documentation using that structure but seems to not works. does it is possible?
It does not describe **required** at path parameters and **nullable** at response object body like this below picture. Here is Joi schema. see, https://github.com/Redocly/redoc ```typescript meta: { ... }, validate:...
It seems for `alternative` only the first option is used. OpenAPI 3.0 supports `anyOf` though. Would it be possible to support it?
