如何解决生成更复杂的 Hapi-swagger 文档
我是 Hapi 和 Hapi-swagger 的新手,我尝试使用 Hapi-swagger 记录我的 API。问题是我无法制作比实际需要更深的物体(见图)。
Swagger generated this documentation(image)
还有我的代码:
'use strict';
const Joi = require('joi');
module.exports = ({
method: 'GET',path: '/test',options: {
description: 'Test route',notes: ['My notes'],tags: ['api'],response: {
schema: Joi.object().keys({
ans: Joi.string().example('My comment example here')
}),},validate: {
query: {
filters: Joi.object().keys({
level: Joi.number().min(1).max(2).optional().description('My description'),property2: Joi.number().min(1).max(2).optional().description('My description of the second parameter'),obj: Joi.object().keys({
propertyX: Joi.number().optional(),propertyY: Joi.string().optional()
}).optional()
}).description('My filter'),anotherObj: Joi.object().keys({
property1: Joi.number().min(1).max(2).optional().description('My description 1'),property2: Joi.number().min(1).max(2).optional().description('My description 2'),property3: Joi.number().min(1).max(2).optional().description('My description 3'),}).description('Just another object')
},}
},handler: async (request) => {
return {ans: 'from test route 1'};
}
});
您还可以在此处找到完整的示例代码:hapi-swagger-docks-question
我尝试做的事情:我尝试使用不同的版本和不同的关键字,我阅读了许多关于不同主题的文档,但找不到任何有用的信息。
我想做的事情:我希望能够记录我的路由验证模式中任何对象的每一个键,以便将其记录在 Hapi-swagger 中。此外,它还可以让我手动输入特定对象的某些值,然后通过按“尝试一下!”进行测试。按钮。
这真的可能吗? 如果是,那我做错了什么?
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。