生成的swaggerjson,导入到runapi, 请求body参数不能自动添加到json字段说明中
"post": { "tags": [ "渠道接口控制器,遵循 REST 规范提供 CRUD 接口。" ], "summary": "新增渠道。", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer token。示例:Bearer xxxx", "required": true, "schema": { "type": "string", "default": "{{authorization}}", "example": "{{authorization}}" }, "example": "{{authorization}}" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddChannelCommand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddChannelCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddChannelCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddChannelCommand" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean", "example": true } }, "application/json": { "schema": { "type": "boolean", "example": true } }, "text/json": { "schema": { "type": "boolean", "example": true } } } } }
"components": { "schemas": { "AddChannelCommand": { "type": "object", "properties": { "channelName": { "type": "string", "description": "渠道名称,1-50字符,支持中英文数字及常用符号。", "nullable": true }, "phone": { "type": "string", "description": "手机号,必须为11位数字。", "nullable": true }, "businessType": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessCategoryEnum" }, "description": "业务分类,必填,默认值为["写作"],选项范围:["写作", "发表"]。", "nullable": true }, "writingType": { "type": "array", "items": { "$ref": "#/components/schemas/WritingTypeEnum" }, "description": "写作类型,当业务分类包含"写作"时必填,选项范围:["论文写作","案例协作","调研报告","财务分析","加字符","降重","单独修改"]。", "nullable": true }, "enable": { "type": "boolean", "description": "状态,必填,默认值为true。", "example": true }, "creatorEmployeeId": { "type": "string", "description": "创建人编号。", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "新增渠道命令。" },
导入到runapi之后,如截图,json字段说明中不会自动添加对应的字段。请帮忙解决
我推送了一些代码。你尝试更新showdoc服务端
由于团队已经用runapi生成了很多项目,且正在使用中。
更新showdoc服务端会不会有什么影响,然后必须要在低峰期更新吗?
你可以晚上少人的时候更新。更新前注意备份即可。有问题就回退。
导入json文件的解释是在showdoc服务端进行的。所以改了那部分解析代码。
我上面列的是一个问题,还有几个问题
- 如果入参或出参是body, 导入到runapi,不会自动美化成json格式,而是一行,这个能解决吗?
- 如果代码里删除了一个接口,重新导入,这个接口在runapi不会自动删除,这个能解决吗?我尝试了删除或者注释代码,都不可行
- 假设我想有些接口不在runapi展示,但是接口是存在的,这种情况脚本应该修改成什么样子?
- 有些接口是query参数,这个query参数导入之后,默认值都是null,我想改成空,尝试了几次都没成功,这个应该怎么改脚本?
目前遇到的大概就这几个问题,帮忙看下
1,runapi有个格式化按钮,自己要查看的话点一下即可 2,不支持删除接口 3,不注释即可。脚本是扫描注释的。 4,暂时没有太好办法。脚本不太好识别空。建议给个默认值
第3点不太明白意思,请再解释一下,我是想生成json的时候没有这个接口。
你是通过脚本扫描注释生成runapi文档的吧?如果是,你不要写注释,它就不生成文档了。 我没明白你说的
我知道了,感谢,上面的问题我升级之后试试看
- request body在升级showdoc后,可以自动生成到json字段说明的表格中
- 现在有另一个问题,是使用runapi的时候,如果接口返回400这种,在页面上看不到错误信息,但是在postman就没问题
一般这种情况就是响应为空。至于为什么为空,就不知道了。可能是接口的安全机制,有可能是错误信息写到header,要切换到响应头