腾讯云
开发者社区
文档
建议反馈
控制台
登录/注册
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
搜索
搜索
关闭
发布
文章
问答
(9999+)
视频
沙龙
1
回答
如何
注释
我
属性
,
它是
值
对象
,
以便
API
平台
为
swagger
文档
生成
其
字段
?
、
、
、
、
我
有一个名为Station的实体。 这个实体有一个名为attributes的
属性
,
它是
StationAttributes
值
对象
。
我
尝试将
属性
设置
为
StationAttributes /*** @ORM\Column(name="attributes", type="station_attributes", nullable=true)
浏览 9
提问于2019-05-23
得票数 0
回答已采纳
1
回答
添加Jackson ObjectMapper到
Swagger
、
、
、
、
我们在Spring REST控制器中使用各种
swagger
注释
import io.
swagger
.annotations.ApiOperation但是,我们希望配置数据
对象
中的
字段
在
Swagger
文档
中的显示方式。例如,我们可能希望
字段
名使用驼峰式大小写。暂时把
Swagger
放在一边,
我
知道我们可以使用Jack
浏览 0
提问于2018-05-30
得票数 1
1
回答
使用
swagger
隐藏
api
模型
属性
、
、
我
目前有几个共享公共
对象
的
API
。在某些情况下,
我
希望在
生成
swagger
文档
时隐藏这些常见
对象
的某些
属性
。age; } 对于某些
API
,
我
希望年龄
字段
出现在
swagger
文档
中,但在其他
API
中<em
浏览 11
提问于2017-03-08
得票数 3
5
回答
与
Swagger
相比,使用Spring
文档
有什么好处?
、
、
、
Spring REST Docs最近发布了,
文档
中说: 这种方法可以使您摆脱像
Swagger
这样的工具所施加的限制。因此,
我
想问一下,与
Swagger
相比,Spring REST
文档
什么时候更适合使用,以及它能释放哪些限制。
浏览 3
提问于2015-12-24
得票数 42
回答已采纳
1
回答
无法在OpenApi中使用带有
注释
的Spring将头设置
为
可选
、
我
使用Java11.0.2、SpringBoot2.2.6和Spring 1.1.49来使用
注释
创建一个OpenApi
文档
。在请求在Controller中创建一个商人时,
我
需要一个自定义header
属性
,但它必须是可选的。基于参数
对象
的
Swagger
文档
,
字段
"required“(确定此参数是否
为
强制参数)。如果参数位置
为
"path",则需要此
属性
,且
浏览 11
提问于2020-05-14
得票数 0
2
回答
System.Text.Json
字段
序列化在.NET 5中没有显示在Swashbuckle定义中
、
、
、
我
已经验证了通过通过Postman调用
API
来正确序列化
字段
,但是Swashbuckle
生成
的
Swagger
定义没有正确地反映这一点。(定义只显示一个空类型)
我
已经创建了一个来复制这个。它在/
api
/Test提供了HTTP方法,它返回带有
字段
和
属性
的Test类型的
对象
。两者都是字符串。通过Postman调用此
API
将返回两个
API
的正确
值</em
浏览 1
提问于2020-11-27
得票数 14
回答已采纳
1
回答
Swagger
和Springfox更改不同状态代码的示例响应
、
、
我
有一个特定的DTO,
我
用它作为
Swagger
文档
的示例返回。如果
我
有一个成功的201代码,
我
该
如何
更改示例?
swagger
中的示例响应: ?
我
使用
注释
"@ApiModelProperty“来描述
我
的
对象
,但是没有办法
为
不同的响应代码更改示例。在
我
的代码中,
我
不想显示错误列表,因为
它是
一个可
浏览 94
提问于2021-09-24
得票数 3
回答已采纳
2
回答
如何
忽略
Swagger
体输入但仍显示在响应上的
属性
?
、
、
、
、
我
使用Swashbuckle和
Swagger
自动
生成
API
文档
。public int?ID { get; set; }
我
的端点方法以PersonViewmodel作为主体,并使用IActionResult返回一个PersonViewmodel但是,
我
不希望用户定义一个ID,因为
它是
由业务逻辑
生成
的。在代码中,如果设置
浏览 6
提问于2021-10-21
得票数 0
2
回答
从
swagger
响应中排除模型或
属性
、
、
、
我
在
我
的apache cxf项目中使用了
swagger
,使用了@
Api
和@ApiOperations以及@ApiParam
注释
,并为rest服务
生成
了一个
api
文档
。但我想从模型
属性
或完整的模块或
属性
属性
中排除一些
字段
,如EntityTag、StatusType和MediaType等。
如何
做到这一点?
我
从db获取数据,并将其设置
为</e
浏览 1
提问于2015-01-05
得票数 17
1
回答
用于自定义响应的傲慢注解?
、
、
、
ProductController:@RequestMapping("/
api
/v1")
如何
描述/记录
Swagger
中CustomRepsonse的各个
属性
?也就是说,是否有一个
Swagger
注释
来描述Custom
浏览 2
提问于2017-07-31
得票数 2
回答已采纳
1
回答
使用
Swagger
的注解在
swagger
UI中显示XML/JSON样本
值
、
、
、
我
正在实施基于泽西的REST
API
,并使用
swagger
来
生成
基于HTML的
文档
。
我
正在使用
swagger
的
注释
来读取和扫描资源以
生成
文档
。
我
已经使用@ApiResponse
注释
为
每个资源指定了响应,如下所示:@
Api
(value = "Hello World"
浏览 0
提问于2016-03-16
得票数 5
4
回答
使用Springfox-
Swagger
2自定义
Swagger
UI中的请求标头描述
、
、
、
、
我
在
我
的Spring Boot应用程序中使用Springfox
Swagger
2版本2.4.0、Springfox
Swagger
UI版本2.4.0和
Swagger
Annotation版本1.5.0这里的问题是,
我
能够为
我
的控制器的
API
生成
swagger
UI,并且能够对
其
进行测试。但我无法
为
我
的请求标头指定请求标头描述。
我
使用@Reque
浏览 4
提问于2017-02-20
得票数 9
1
回答
如何
在
Swagger
2中
为
每个端点添加不同的示例?
、
、
、
、
我
的控制器类中有几个方法,它们需要相同的Model/Payload类。
我
已经用@ApiModelProperty
注释
了那个类的
属性
。
我
已经
为
它们中的每一个提供了一个示例
值
。现在,当
Swagger
文档
生成
时,它使用这些
值
来创建一个完整的示例。到现在为止还好。 当我在请求中只需要一些
字段
时,问题就开始了。例如,当请求在/endpoint/1上打补丁时,<e
浏览 0
提问于2019-07-24
得票数 0
1
回答
通过Spring配置全局定义
Swagger
3.0 (OpenApi)类型架构
、
、
、
、
在最近与我的团队一起启动了一个基于Spring的新项目之后,我们决定放弃我们众所周知但过时的
Swagger
2.0
文档
实践,转而使用
Swagger
3.0标准来遵循OpenApi指令。为了避免过于激烈的跳跃,我们试图坚持基于配置和
注释
的自动
生成
文档
风格。然而,这并不是没有困难的。 我们只想为一些高度可重用的类型定义一次模式,供整个项目使用。也就是说,我们使用org.bson.types.ObjectId
字段
,同时使用-to-string和string-to-序列化器
浏览 2
提问于2020-02-11
得票数 0
3
回答
有没有办法在
Swagger
中指示字符串模型
属性
具有最大长度?
、
、
除此之外,我们还有
swagger
,使用
注释
为
资源提供
文档
。问题 我们希望看到这些限制在
swagger
生成
的
文档
中可见。有没有办法做到这一点?
浏览 0
提问于2015-11-17
得票数 17
回答已采纳
1
回答
如何
指定请求正文(POST)中哪些
字段
是必需的?
、
我
试图在在线
Swagger
编辑器中的用户类上定义POST方法。
我
要做什么/改变什么才能做到这一点?
我
尝试过各种“必需”关键字的变体(请参见下面的图片中的一个关键词),但是没有能够完成这项工作,它没有显示在
生成
的
文档
中(请参阅右边的图片,
我
的<
浏览 4
提问于2020-09-17
得票数 2
回答已采纳
4
回答
自动
生成
RESTful
API
示例JSON
、
、
、
我
在Jersey2.17和杰克逊有一些RESTful
API
。它们都采用JSON风格,工作非常好。首先
我
试了, 它使用Json示例直接
生成
HTML
文档
。然后
我
尝试了,它知道一些杰克逊
注释
,比如@JsonProperty,但仍然不能处理@JsonIgnore。它也是数据模式的描述,而不是示例。如果
API<
浏览 3
提问于2016-12-06
得票数 0
回答已采纳
7
回答
不推荐
Api
注释
的描述
、
、
、
在
Swagger
中,不推荐使用
注释
的元素。 是否有一种新的方式来提供描述?
浏览 12
提问于2016-06-28
得票数 77
1
回答
Swagger
:第一个枚举
值
覆盖类型
、
、
、
、
我
正在使用
swagger
文档
为
我
的应用程序
生成
API
。Doc是用yml编写的,在某些地方它将定义一些
属性
,这些
属性
是enum (我们使用mysql)。. // And so on and on{ "title": "string",正如您所看到
浏览 1
提问于2015-06-26
得票数 0
1
回答
Swagger
API
未刷新
文档
、
、
、
我
使用
Swagger
API
来记录
我
的REST服务。早些时候
我
的控制器方法没有信息性的
注释
,所以
Swagger
API
没有显示描述,但现在即使在更新了
注释
之后,
我
也没有在突出显示的区域中获得方法描述。name="retailerId"></param> /// <param name="returnId"&
浏览 0
提问于2017-03-16
得票数 11
回答已采纳
点击加载更多
相关
资讯
Swagger与JSR-303的联合作战
NET Core WebAPI集成Swagger做接口管理
重磅:Swagger3.0 官方 starter 诞生了,其它的都可以扔了
重磅:Swagger3.0官方starter诞生了,其它的都可以扔了
写文档太麻烦,试试这款 IDEA 插件吧!
热门
标签
更多标签
云服务器
ICP备案
云直播
实时音视频
即时通信 IM
活动推荐
运营活动
广告
关闭
领券