Swagger UI中 @ApiImplicitParam 的 readOnly 没有生效

时间: 2024-03-08 13:47:31 浏览: 22
Swagger UI中的@ApiImplicitParam的readOnly属性是针对文档生成工具的,用于指示生成的文档中该参数是否可写。但是该属性不会影响实际的API调用。如果您希望API参数在实际调用时不可编辑,应该在代码实现中进行验证和设置。您可以在API实现中使用@ModelAttribute注解标注参数,然后在该注解中设置readOnly属性为true,以确保该参数不可编辑。例如: ```java @PostMapping("/user") public void addUser(@ModelAttribute("user") @ApiParam(value = "用户信息", readOnly = true) User user) { // 验证user参数是否可编辑 if (!user.isReadOnly()) { // 设置user参数为只读 user.setReadOnly(true); } // 添加用户逻辑 } ``` 此处的User类需要实现isReadOnly和setReadOnly方法。同时,您还需要在Swagger配置文件中为文档生成工具设置readOnly属性为true。 ```yaml swagger: api: docket: enable: true globalOperationParameters: - name: "readOnly" in: "header" description: "是否只读" required: false schema: type: "boolean" default: true ```

相关推荐

最新推荐

recommend-type

Swagger 自定义UI界面.doc

整合Springboot2.0,swagger接口文档。Swagger 自定义UI界面,美观,蓝色风格,实测通过。欢迎大家下载
recommend-type

Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题

主要介绍了Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
recommend-type

SpringBoot集成SwaggerUi以及启动时遇到的错误

主要介绍了SpringBoot集成SwaggerUi以及启动时遇到的错误,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
recommend-type

详解spring cloud整合Swagger2构建RESTful服务的APIs

主要介绍了详解spring cloud整合Swagger2构建RESTful服务的APIs,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
recommend-type

钢桁架结构振动特性渐变分析工具

钢桁架结构振动特性渐变分析工具
recommend-type

zigbee-cluster-library-specification

最新的zigbee-cluster-library-specification说明文档。
recommend-type

管理建模和仿真的文件

管理Boualem Benatallah引用此版本:布阿利姆·贝纳塔拉。管理建模和仿真。约瑟夫-傅立叶大学-格勒诺布尔第一大学,1996年。法语。NNT:电话:00345357HAL ID:电话:00345357https://theses.hal.science/tel-003453572008年12月9日提交HAL是一个多学科的开放存取档案馆,用于存放和传播科学研究论文,无论它们是否被公开。论文可以来自法国或国外的教学和研究机构,也可以来自公共或私人研究中心。L’archive ouverte pluridisciplinaire
recommend-type

实现实时数据湖架构:Kafka与Hive集成

![实现实时数据湖架构:Kafka与Hive集成](https://img-blog.csdnimg.cn/img_convert/10eb2e6972b3b6086286fc64c0b3ee41.jpeg) # 1. 实时数据湖架构概述** 实时数据湖是一种现代数据管理架构,它允许企业以低延迟的方式收集、存储和处理大量数据。与传统数据仓库不同,实时数据湖不依赖于预先定义的模式,而是采用灵活的架构,可以处理各种数据类型和格式。这种架构为企业提供了以下优势: - **实时洞察:**实时数据湖允许企业访问最新的数据,从而做出更明智的决策。 - **数据民主化:**实时数据湖使各种利益相关者都可
recommend-type

可见光定位LED及其供电硬件具体型号,广角镜头和探测器,实验设计具体流程步骤,

1. 可见光定位LED型号:一般可使用5mm或3mm的普通白色LED,也可以选择专门用于定位的LED,例如OSRAM公司的SFH 4715AS或Vishay公司的VLMU3500-385-120。 2. 供电硬件型号:可以使用常见的直流电源供电,也可以选择专门的LED驱动器,例如Meanwell公司的ELG-75-C或ELG-150-C系列。 3. 广角镜头和探测器型号:一般可采用广角透镜和CMOS摄像头或光电二极管探测器,例如Omron公司的B5W-LA或Murata公司的IRS-B210ST01。 4. 实验设计流程步骤: 1)确定实验目的和研究对象,例如车辆或机器人的定位和导航。
recommend-type

JSBSim Reference Manual

JSBSim参考手册,其中包含JSBSim简介,JSBSim配置文件xml的编写语法,编程手册以及一些应用实例等。其中有部分内容还没有写完,估计有生之年很难看到完整版了,但是内容还是很有参考价值的。