我想使用swagger来记录我们内部的Jenkins Job和参数。这样每个人都知道要通过API正确地触发Jenkins作业，主体必须是什么样子的。我正在用一个swagger.yml文件编写API文档。我最努力的地方是记录嵌套的对象。 Jenkins需要JSON中的参数。}, "name": "FileContent&qu
浏览 30提问于2020-06-27得票数 1
回答已采纳
1回答
我有一个返回对象的Web API REST web服务。我已经安装了以及Swagger UI。我希望Swagger UI列出从Web API REST方法返回的对象中的字段。这个是可能的吗？在Swagger文档中，Swagger.NET使用ApiExplorer收集有关我拥有的Web API端点(扩展ApiController<
浏览 9提问于2013-04-24得票数 2
1回答
在Swagger API文档中，除了API数组之外，json中还有一个模型对象条目，但是没有关于它的文档。如何使用这个“模型”部分？{ swaggerVersion: "1.1",
basePath: "http://petstore.swagger.wordnik.com/api
浏览 1提问于2013-03-04得票数 19
回答已采纳
1回答
本文档已准备好用于Nodejs create API，如何为嵌套对象编写swagger文档。下面是我完整的swagger文档代码。但是它不显示用户对象。帮我解决这个问题 @swagger post: - Employees
summar
浏览 60提问于2021-01-14得票数 0
回答已采纳
我有一个spring启动应用程序，我正在使用springfox swagger来生成API文档。我有一个带有复杂嵌套对象的搜索端点 @GetMapping("/search")}
<groupId>io.springfox<
浏览 44提问于2020-06-19得票数 0
我能够阅读原始JSON的邮政请求。但不确定我做得对不对？码 (:require [compojure.api.sweet :refer :all] [clojure-dauble-business-api.logic :as logic]
浏览 5提问于2017-07-25得票数 0
回答已采纳
2回答
我正在为API编写Swagger文档，其中一个端点返回许多嵌套对象和参数。 "label": "Available", "primary": true]
浏览 4提问于2017-08-01得票数 6
6回答
如何生成离线Swagger文档？
、、、、
我已经能够集成Springfox的API文档。当服务器启动和运行时，我可以直观地看到所有的API。
如何生成离线的swagger文档？注意:我不想使用asciidoc或标记文档，但我想在html文件中使用相同的swagger用户界面。我希望链接是相对于本地目录而不是本地主机服务器链接。谢谢
浏览 10提问于2016-01-25得票数 17
回答已采纳
2回答
当您在Springfox应用程序中使用Springfox启动Swagger时，如下所示：如何配置标题和描述("Api文档“)和许可证(Apache2.0)。
浏览 3提问于2017-09-11得票数 2
回答已采纳
我使用的是Ocelot网关和使用"MMLib.SwaggerForOcelot“库的swagger文档。对于某些swagger键，swagger显示“没有在规范中定义的操作！”傲慢的JSON将无路可走，就像 "openapi": "3.0.1", "title": "Admin API"
浏览 25提问于2022-05-20得票数 1
回答已采纳
我用它来创建一个公共API。我使用devise simple http进行基本身份验证。 response :unauthorized end
问题是如何设置嵌套资源，提供:product_id的参数以及与产品id一起工作的控制器操作来查找给定产品<em
浏览 4提问于2014-03-28得票数 1
我有一个带有Swagger端点文档的REST SpringBoot应用程序。但是我的老师说使用JavaDoc JavaDoc和Swagger有什么不同？
浏览 96提问于2019-12-09得票数 0
回答已采纳
1回答
我试图用记录一个已经存在的python。我编写了swagger.yaml，并在的帮助下记录了每条路径。现在，我想使用部署文档。( swagger.yaml文件的简要示例)info:excepti
浏览 1提问于2019-01-04得票数 2
Restlet网络服务API是使用RESTful实现的。我需要为这些文件生成API文档。我不是从一个单独的文档开始，而是评估是否可以从源代码注释本身生成这个文档。
我看了看“摇摆”和“宣言”。Swagger似乎是基于JAX规范的。由于有一个FAQ提到了如何为非JAX实现生成，所以它看起来更有希望，但是没有帮助。是否有从Restlet注释生成API文档的工具(或者社区使用过任何工具)
浏览 3提问于2012-11-21得票数 2
回答已采纳
我为我的.Net 5 Web项目启用了健康检查{ }不幸的是，健康端点没有出现在swagger文档中。HttpStatusCode.ServiceUnavailable;
浏览 2提问于2021-05-28得票数 4
回答已采纳
我们使用Swagger来记录我们的REST API。，它包括我们使用的所有数据对象及其定义，其中包括所有字段。但是，我们希望配置数据对象中的字段在Swagger文档中的显示方式。例如，我们可能希望字段名使用驼峰式大小写。我们希望将其与使用mixins的数据对象分开，然后使用jackson ObjectMapper将mixins注册到数据对象。我的
浏览 0提问于2018-05-30得票数 1
我有一个Jhipster项目作为一个整体，它将Swagger 2文档以JSON文件的形式公开在/v2/api-docs中。Jhipster还创建了Swagger 2 UI。但是，我需要JHipster来创建Open API3.0格式的JSON文件，但是找不到有关它的任何信息。JHipster文档谈到了使用Open API3.0进行API first开发，但没有提
浏览 32提问于2020-08-27得票数 1
3回答
我一直在研究swagger作为自动为我的团队的api 生成文档的可能方法。这似乎很有希望，但我发现他们的文件缺乏。
话虽如此，我有几个非常基本的问题。是否可以只对Spring应用程序使用swagger？我们的应用程序既不是运动衫，也不是JAX-RS应用程序。有人知道普通的Spring应用程序是否可以与swagger一起使用吗？我已经找到了这个链接，但是他们浏览了<
浏览 3提问于2015-10-16得票数 0
我用JSDoc制作了我的Javascript API文档。在创建它们之后，./docs目录生成了我制作良好的JSDoc文档所在的位置。但我认为，每个.js文件都有太多不同的文件，如图标、脚本、样式、html文件……等。有没有什么简单美观的方法可以把这些文件变成像Redoc这样的集成html文件，这是最好的应用编程接口文档工具(对我来说:-D)？
浏览 16提问于2020-08-28得票数 0
回答已采纳
1回答
我想为插件生成swagger文档。
我将api的端点指向一个plugincontroller。在这里，我有一个为特定版本创建文档的方法。加载插件时，所有项目都已在swagger工具中注册。(不知何故，新文档不会被swagger中间件拾取，这就是我需要这个变通方法的原因。)[HttpGet("api/plugins/swaggerdoc/{version}&qu
浏览 5提问于2018-12-20得票数 0
云服务器
ICP备案
云直播
实时音视频
即时通信 IM
腾讯云开发者
