我正在使用Swagger创建api。我的api工作得很好。现在我想要的是，我想为返回我的api的每个数据添加描述。假设这是我的api功能。@SWG\POST( tags={"datas"}, description函数返回的
浏览 36提问于2019-02-28得票数 0
回答已采纳
我在googled上搜索了一点，以找到一种合适且易于实现的方法，为现有的Rails API应用程序生成文档。简而言之，有两种实现方式:通过控制器、模型或通过Rspec控制器/请求规范。清单不长，作出选择也不那么容易：
宝石，-最古老的优点:实现要在控制器中完成。缺点:不支持Swagger V2版本，仅限于1.2。gem，改进版本的swagger-docs，支持Swagger V2版本，实现将在控制器、模型中完成。但是我无法使它工作，无法解
浏览 0提问于2018-12-04得票数 6
我试图为我的API路由生成OpenAPI (Swagger)文档，这需要HMAC-API 256身份验证。这意味着我必须为每个请求包括Authorization头，该请求由API键组成，生成的HMAC签名由冒号(例如Authorization: API_KEY:GENERATED_SIGNATURE)分隔。我可以很容易地用JavaScript生成所需的签名，但我不知道如何在Swagger中添
浏览 5提问于2017-06-19得票数 10
4回答
使用Swagger的基本身份验证
、、、、
我正试图通过Swagger开发一个基于spring的rest服务，并提供API文档。我希望通过swagger启用基本身份验证，以便用户只能在使用swagger上的“授权”按钮(通过该按钮向API调用中添加"authorization: Basic XYZ头)进行身份验证时才能运行API的API。在前端(在Swagger的.json文件中，我使用以下代码为
浏览 8提问于2019-09-26得票数 2
回答已采纳
我使用Swagger 2.0生成文档。在我的控制器类中，我有一些像这样的操作："responses" : { "schema" : {
&quo
浏览 7提问于2015-06-04得票数 6
2回答
我想自动生成API调用的描述，包括：
2.)对端点/页的描述我花了相当长的时间搜索各种查询，似乎找不到答案。
编辑:在我的例子中，在ASP.Net帮助页面上使用Swagger</
浏览 5提问于2015-06-12得票数 13
回答已采纳
1回答
我正在尝试使用葡萄标榜宝石为我的葡萄API创建自动生成的文档。示例：
按照“”的文档，我无法正确地生成API文档。我的脚步：
宝石‘葡萄-傲慢’
通过在config.ru中添加下面的内容，我还使用了机架CORS来启用CORS。要求'
浏览 8提问于2015-05-27得票数 1
1回答
我使用作为api文档，当我谈到响应时，我想在每个响应中添加一个任意名称的新列，
"404" : { }
如何在其中添加新
浏览 1提问于2016-01-26得票数 1
4回答
我在Jersey2.17和杰克逊有一些RESTful API。它们都采用JSON风格，工作非常好。首先我试了，我还试过jaxrs-raml plugin，它只能使用JAXB生成不准确的示例。基本上，我的要求很简单：
从JAX注释中生成端点URL和参数描述，我尝试过的每
浏览 3提问于2016-12-06得票数 0
回答已采纳
为了改进我们的api文档，我想向响应体的一个字段添加一个描述在宠物响应的POST /pet中，status的描述为“商店中的宠物状态”
我如何在我的代码库中从注释的角度来做这件事呢(swagger v3)
浏览 6提问于2021-01-20得票数 0
我知道它应该放在请求体中，但是它如何与其他元数据相匹配呢？对于实际的swagger文本，名称/值对的名称部分是什么？我试图通过传入swagger文档的字符串表示形式，将swagger文档导入Azure API管理。根据下面的文档，“Content”应该设置为"application/vnd.swagger.doc+json“，"import”查询参数应该设置<
浏览 1提问于2017-05-31得票数 0
回答已采纳
我正在尝试为我的单个端点API提供Swagger/Open文档。
Body2: {"jsonClass": "AnimalsInRegion", "region":"Africa", "type":"lions"} Response2: schema-2
文档期望:<
浏览 4提问于2017-09-16得票数 3
2回答
我有一个API网关API设置，我正在为我的Integration Response添加一个Integration Response以获得一个400*错误组：我只想得到当前响应的StatusCode
浏览 4提问于2017-01-16得票数 0
回答已采纳
目前参与了一个基于django的项目，致力于rest API开发。使用Swagger跟踪文档。直到今天，一切都很顺利。今天我试着为端点添加一些测试用例。为了使测试工作，出于某种原因，我需要在设置中设置SOUTH_TESTS_MIGRATE = False并从INSTALLED_APPS中删除allauth.socialaccount。但是在那之后，当我尝试使用Swagger来跟踪API中的每个端点时
浏览 2提问于2014-08-14得票数 1
我有一个API调用，它响应200 OK并返回一个HTML。我想将此添加到我的API文档中(特别是因为我使用dredd验证它，并且除非我提供了预期的响应体，否则测试失败)。</body></html> + Response 302 (text/html; charset=utf-8)
+ Body<
浏览 13提问于2016-08-13得票数 9
我正在尝试为一个大型的非Swagger文档的应用程序接口编写一个客户端，我认为为它编写swagger.json并使用AutoRest将是实现该目标的一个好方法。实际情况是，此API将每个操作的响应数据包装到一个更大的对象中，其中包含控制信息，如下所示： "resp_code": "SUCCESS",
"caller_ref": "
浏览 0提问于2016-11-12得票数 1
1回答
我目前有几个共享公共对象的API。在某些情况下，我希望在生成swagger文档时隐藏这些常见对象的某些属性。. */对于某些API，我希望年龄字段出现在swagger文档中，但在其他API中我不这样做。
我不想使用@ApiModelProperty注释的hidden属性，因为这将隐藏所有API的属性。在该方法中似乎没有任何参数可以用来找出哪个Api正在使用Model
浏览 11提问于2017-03-08得票数 3
我目前正在一个代码库中工作，对于每个REST响应，它们都使用一个java类，如下所示Object payload;String responseStatus，则响应将有有效负载，如果出现错误，则列出错误列表，并将响应状态分别设置为成功或失败。是否有任何方法来改进swagger文档，以便我能够显示特定API响应的响应有效负载json将是什么样
浏览 5提问于2021-12-15得票数 3
我想要做的是为该端点启用CORS标头。我已经将以下方法添加到SwaggerConfig中，如中的全局CORS配置中所述。CORS报头不在响应中。(与我自己的控制器方法形成对比，这些方法用@Cross
浏览 5提问于2017-08-14得票数 16
回答已采纳
云服务器
ICP备案
云直播
即时通信 IM
实时音视频
腾讯云开发者
