腾讯云
开发者社区
文档
建议反馈
控制台
登录/注册
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
搜索
搜索
关闭
发布
文章
问答
(9999+)
视频
沙龙
1
回答
我
的
Swagger
文档
(
也
称为
Open
API
)
是否
应该
定义
500个
响应
代码
?
、
、
、
如果
我
要使用像AutoRest这样
的
客户端生成器,
我
是否
希望生成
的
客户端预期500个错误?这只是一个
我
需要做出
的
风格决定吗?
浏览 1
提问于2017-07-19
得票数 1
回答已采纳
5
回答
Swagger
可以基于现有的快递路线自动生成yaml吗?
、
、
、
、
我
继承了一个现有的
API
,
我
想用
swagger
来记录它,但我还不知道它
的
全部范围。
Swagger
(或其他中间件/工具)
是否
可以基于现有的express路由自动生成yaml (用于
swagger
)?对于我在其他问题上看到
的
,这似乎主要是一个手工工作,但我正在仔细检查这里
是否
有人找到了解决这个问题
的
方法。
浏览 2
提问于2015-07-09
得票数 55
1
回答
openapi.yaml文件在Google Cloud Function
的
什么地方?
、
我
创建了一个简单
的
谷歌云函数,并想。它说
我
需要编辑openapi.yaml文件。
我
找不到它。 在哪里可以找到谷歌云项目的openapi.yaml文件?
浏览 9
提问于2020-05-26
得票数 1
回答已采纳
1
回答
基于
Swagger
文档
的
RestAsure检查Json
响应
模式
、
、
我
正在为
我
的
API
端点实现集成测试。为了验证json
响应
模式,
我
使用了
swagger
文档
。通常,
我
必须将
swagger
转换为json并手动创建Json模式文件。
我
发现所有的技巧信息都是在
swagger
文件中
定义
的
,它
应该
有一些方法可以直接从
swagger
文档
验证json
响应
。
浏览 1
提问于2018-04-03
得票数 0
回答已采纳
1
回答
使用swashbuckle
的
多个前置条件失败
的
注释
、
我
正在使用来记录
我
的
web
api
项目,
我
不能为前置条件失败
的
情况添加多个
响应
,
swagger
只显示最后一个。</response>{ }, "description": "
浏览 2
提问于2016-03-23
得票数 1
1
回答
如何在
swagger
ui中添加其他
响应
码?
、
、
、
我
已经通过在pom.xml中导入
open
API
依赖项创建了一个
API
规范
文档
,但在生成
的
swagger
UI界面中,
我
的
架构仅适用于200个
响应
。
我
是否
需要手动添加其他
响应
,或者
swagger
可以自动生成它
浏览 37
提问于2021-09-23
得票数 0
1
回答
我们必须在openapi 2.0中手动配置
api
端点吗?
、
、
、
、
我
对Java很陌生。
我
正在开发一个使用openapi2.0
的
遗留应用程序。
我
添加了一个带有两个
api
端点
的
新控制器。这两个
api
端点并没有出现在
swagger
中。
我
看到了openapi.json中现有端点
的
条目。
我
正在尽
我
最大
的
努力不手动编辑openapi.json。我们
是否
必须在openapi.json版本2.0中手动配置
api</em
浏览 6
提问于2022-02-09
得票数 2
2
回答
我
是否
需要对这些APIS进行JSON模式验证?
情况如下:
我
有许多经过单元测试
的
API
。一个
swagger
规范(
swagger
2.0)是由
API
上
的
代码
注释自动生成
的
。
我
目前正在考虑根据自动测试脚本中
的
模式验证JSON
响应
,但这真的很有用
浏览 0
提问于2021-03-05
得票数 1
回答已采纳
1
回答
使用flask-restx进行
API
响应
的
Swagger
文档
、
、
、
我
正在阅读有关flask-restx
的
swagger
文档
的
the documentation,并遵循以下示例。
我
知道为了生成
API
参数
的
swagger
文档
,
我
应该
这样做。@
api
.doc(params={'id': 'An ID'}) 但是,
我
找不到如何记录
API
响应
正文
浏览 85
提问于2021-09-08
得票数 0
回答已采纳
2
回答
傲慢
的
最佳做法
我
已经开始用
Swagger
-Editor.中
的
Open
规范来
定义
API
规范但是稍后,
我
可能需要修改这个
API
,
我<
浏览 2
提问于2016-06-14
得票数 13
回答已采纳
4
回答
斯莱特对斯威格-哪一个更好,谁有更多
的
选择?
、
、
、
我
必须记录
我
的
API
,
我
必须使用其中
的
任何一个或。
我
想知道哪一个有更多
的
选择,利弊,哪个更好。
浏览 0
提问于2015-04-06
得票数 35
回答已采纳
1
回答
如何在
Swagger
中显示单个
API
?请看下面的截图。
、
、
、
、
我
正在尝试实现一个
Swagger
文档
,比如附带
的
屏幕截图。
我
有一个昂首阔步
的
端点。
我
希望自
定义
Swagger
以如下方式显示
API
文档
:
API
名称
API
Description
Swagger
UI --在这里试用单个
API
通过其端点URL >H19</code>
API
字段<
浏览 0
提问于2020-05-27
得票数 0
1
回答
REST
API
是否
应该
定义
与成功
响应
不同
的
错误
响应
?
、
、
API
的
成功
响应
是json格式(基于avro模式)。对于错误,它
是否
应该
为异常
定义
另一种格式(模式)?或者,成功
的
响应
是否
应该
包含一个错误部分?当发生错误时,将其他部分保留为空,仅填充错误。这更像是一个内部
API
,需要
定义
各种自
定义
异常消息。它
是否
应该
对所有此类应用程序错误使用相同
的
HTTP状态
代码</
浏览 0
提问于2020-08-12
得票数 0
2
回答
在Web路由(和子端点)上强制404
、
、
、
、
我
正在寻找一种简单
的
方法来返回Web
API
中所有请求到给定路由
的
404错误,以及该路由中
的
所有端点。在
我
的
场景中,
我
将有一个配置标志来打开和关闭它。它是一个使用
Swagger
/Swashbuckle
的
文档
端点,并希望能够将其作为一种功能切换打开或关闭。<add key="EnableDocumentation" value="true|false&qu
浏览 4
提问于2014-07-14
得票数 0
3
回答
将
swagger
添加到我
的
nodejs restify项目
、
、
我
有一个基本
的
nodejs restify服务器,有两个简单
的
方法,一个GET和一个POST。
我
正在尝试将
swagger
API
文档
添加到我
的
restify服务之上。找到了对express
的
支持。还发现了一些库https://www.npmjs.com/package/
swagger
-restify。但我不知道如何在code.How中使用它来添加它,这样
我
<e
浏览 60
提问于2021-02-12
得票数 2
2
回答
自
定义
Hyperledger Composer Rest服务器
、
我
有一个在IBM Cloud中运行
的
测试Hyperledger Fabric,以及IBM Blockchain Application Service。
我
还有一个运行Hyperledger Composer REST Server
的
kubernetes集群。一切都很好,但是
我
如何用一些自
定义
api
来扩展REST
api
呢?
文档
提到能够在IBM
API
Connect或Strongloop product...but中
浏览 1
提问于2018-02-10
得票数 1
4
回答
自动生成RESTful
API
示例JSON
、
、
、
我
在Jersey2.17和杰克逊有一些RESTful
API
。它们都采用JSON风格,工作非常好。首先
我
试了, 它使用Json示例直接生成HTML
文档
。然后
我
尝试了,它知道一些杰克逊注释,比如@JsonProperty,但仍然不能处理@JsonIgnore。它也是数据模式
的
描述,而不是示例。如果
API
直接返回J
浏览 3
提问于2016-12-06
得票数 0
回答已采纳
1
回答
Azure
API
管理-不考虑
响应
上
的
使用
Swagger
2.0规范导入
API
- schema属性
、
、
、
我
想就
我
面临
的
一个问题寻求您
的
帮助。因此,基本上
我
为
API
定义
了
swagger
2.0规范,并且在操作
的
响应
上,
我
使用schema属性来引用反映
响应
结构
的
对象
的
一些
定义
。
我
在
Swagger
编辑器上验证了规范,它是有效
的
,而且如果
我
使用
Swagger<
浏览 19
提问于2018-08-23
得票数 1
回答已采纳
1
回答
Swagger
/ springfox自动生成
响应
示例
、
、
、
、
目前使用springfox 2.9.2来
Swagger
记录在Spring中创建
的
API
。
我
想在
文档
中添加示例
响应
,比如在这个图像中;
我
的
理解是,
我
可以做一些类似的事情: @ApiResponse(code = 200, message不幸
的
是,上面的两个例子总是显示:标识符期望错误@Api
浏览 0
提问于2018-12-04
得票数 16
1
回答
当使用
swagger
2.0记录REST时,如何保持实现和
文档
的
同步?
我
想使用
Swagger
2.0来记录REST,因为这似乎被广泛地用于
文档
RET。 但是,
我
不确定如何将
文档
和实现保存在同步中?例如,当我添加新
的
API
时,
我
必须确保
API
文档
中使用
的
模型(用于表示
响应
)
应该
与REST实现中创建
的
模型相同。类似地,
文档
中给出
的
资源名称
应该
与实现中
的</em
浏览 3
提问于2015-06-18
得票数 8
点击加载更多
热门
标签
更多标签
云服务器
ICP备案
云直播
实时音视频
即时通信 IM
活动推荐
运营活动
广告
关闭
领券