码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • egg-swagger-doc 传对象数组参数解决方案


    博文原创,且看且珍惜。

    需求场景如下图

    1、ajax类型为post请求

    2、参数在body请求里

    3、参数为list 的对象数组并且无参数名 直接就是[{id:1,name:1},{id:2,name:2}] 丢到接口去 

    4、egg的controller可以通过this.ctx.request.body获取到数组

    好的,博主来教你配置他

    首先array[string] 肯定是要报错的,因为array力面是object类型 

    那怎么办

    博主翻了下md文档找到了,这么一句话

    1. ```js
    2. module.exports = {
    3. Model名称:{
    4. 字段名称: { type: "array",required: 字段必要性, itemType:数组元素类型}
    5. }
    6. }
    7. ```
    8. type为array,itemType为具体的数组元素类型,支持自定义类型。

     对的就是自定义类型,又翻了几个egg-swagger-doc的文档博主找到了解决方案

    解决方案

    一、/app/contract/database.js(没有目录或js你就新建)代码如下,你要看清楚博主的自定义类型名是    user 

    1. "use strict";
    2. module.exports = {
    3. user: {
    4. id: { type: "string", required: true, description: "id 唯一键" },
    5. name: { type: "string", required: true, description: "用户姓名" },
    6. sex: { type: "string", required: true, description: "用户性别" },
    7. age: { type: "integer", required: true, description: "年龄" },
    8. },
    9. };

    不用引入,本身egg-swagger就回去读contract下到文件

    二、配置swagger的request注释

    切入位置如下 

    1. /**
    2. * @summary 某某接口
    3. * @Request header string authorization
    4. * @description 测试swagger文档是否可用
    5. * @request body array[user] arr
    6. * @router post /api/xxxxx/create
    7. * @response 200 allString
    8. */
    9. async create() {
    10. let m=this,{app}=m;
    11. debugger

    这里注意 这个user就是前面博主定义的自定义类型

    * @request body array[user]  arr 

    好了,原创不易,且行且珍惜。

  • 相关阅读:
    SpringBoot学习之SpringBoot3集成OpenApi(三十七)
    利用Python提取将Excel/PDF文件数据
    没有谷歌翻译,我该怎么办?
    ubuntu20.04桌面蓝屏问题解决
    特征值和特征向量及其在机器学习中的应用
    xilinx FPGA ROM IP核的使用(VHDL&ISE)
    用调试来帮你分析并拿捏折半插入排序算法的流程
    React源码学习(一):如何学习React源码
    零信任牢不可破,首届CSA西塞杯攻防挑战赛圆满成功
    中国超高分子量聚乙烯产业调研与投资前景报告(2022版)
  • 原文地址:https://blog.csdn.net/xuelang532777032/article/details/127571051
  • 最新文章
  • 沪漂五周年了:我越来越迷茫了
    Agentic Skill Routing 实战:别再把所有 Skill 塞进 AI Agent 上下文
    MySQL-Seconds_behind_master的精度误差
    [MAF预定义ChatClient中间件-03]CachingChatClient——利用缓存省钱省时间
    AI的至暗历史:从万众期待到被政府撤资,AI的两次死亡徘徊
    Agent OS :五种驯服不确定性的范式
    PortSwigger SQL注入LAB11
    数据库即时编译JIT
    [Begin]AI Learn Data Day 0
    深度学习进阶(二十七)现代 LLM 的核心架构设计其二:SwiGLU
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
小工具 小游戏
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1

京公网安备 11010502049817号