-
1 votesanswersviews
没有带Swagger UI的web.xml的Apache CXF
我在没有web.xml的情况下使用CXF进行RESTful Web服务 . 所有CXF和rest endpoints 配置都存储在xml文件中（由Spring管理） . 现在我正在尝试在我的服务中实现Swagger . 我在我的jax-rs配置中添加了SwaggerFeature： <jaxrs:features> <ref bean="swaggerFe... -
1 votesanswersviews
关于Swagger API的建议
我正在使用Java 8使用SpringBoot和Spring REST服务构建API . 我刚刚发现了Swagger API，现在我想使我的API Swagger兼容 . 到目前为止，我读到，Swagger是一个记录您的APIS的工具，但也提供了从规范生成客户端和服务器代码的功能（v2中的swagger.json），以及与您的API交互的漂亮的Web界面 . 现在，我想了解一些关于如何继续的建议，... -
16 votesanswersviews
如何生成swagger.json
我使用java spring boot框架为我的项目创建REST api，我使用"springfox-swagger2 and springfox-swagger-ui"生成swagger文档 . 我可以使用url http://localhost:8080/swagger-ui.html查看我的文档 . How can I crate or generate swagger.... -
60 votesanswersviews
swagger-ui在部署后返回500
开箱即用的配置在我的机器上完美运行，完全没有问题 . 但是当我部署到我们的测试环境时 - 我收到以下消息 500：{“消息”：“发生错误 . ” / api / swagger / docs / v1 部署是 default web site/api 我猜它与baseUrl或类似的东西有关，但我不知道哪里开始 . 我的路线在项目中运行良好 - 我可以调用我的所有webapi endpoints... -
0 votesanswersviews
Swagger Editor生成了python-flask null类型错误
我在Swagger hub / Swagger编辑器上创建了我的rest-ful api endpoints 文档 . 我有基于python-sanic的restful api endpoints . 我生成并运行python-flask服务器，但收到错误消息 . 未捕获的TypeError：Swagger 2.0不支持空类型（[object Object]） . 我已经调查了这个问题，但... -
0 votesanswersviews
Swagger UI无法工作休息APi
我有一个Rest Api项目，我正在尝试使用swagger进行文档和UI . 我能够获得文档但UI没有看到api文档并且空白 . 我已经在webapps / WEB-INF下复制了dist文件夹的内容我可以使用以下方法访问文档：http://localhost:8080/ml-api-ws/v2/api-docs我试图将index.html中的url更改为指向此文档，但是显得空白 . 的webap... -
1 votesanswersviews
使用CXF中的swagger生成脱机文档
我正在尝试使用带有cxf和camel的swagger生成REST文档 . 我已经成功获得了昂首阔步的文档 . 而且我的心烦意乱！ 所以现在我正在尝试导出所有内容并构建离线文档 . 为了做到这一点，我使用：1）swagger-maven-plugin：REST - > json 2）swagger2markup-maven-plugin：json - > asciidoc 我设法得到... -
6 votesanswersviews
生成swigger的cURL命令
我们有一个由swagger running here生成的API文档，我问自己如何让swagger为当前 endpoints /方法生成一个额外的curl命令行示例 . 这可能没有黑客入侵skala吗？ -
2 votesanswersviews
我可以从现有的Java代码中获取Swagger文档吗？
在 Swagger 我绝对是新的，我有以下疑问： 我知道通常我必须在代码我的REST API之前创建Swagger文档并使用此文档来创建我的API（我知道从Swagger编辑器我也可以自动生成我的API服务器） . 我的问题是以下一个： 我正在开发一个实现我的REST API的Java应用程序（Spring Boot应用程序） . 我想使用Swagger来创建我的API文档 . 有办法自动完成吗？... -
1 votesanswersviews
使用Spring REST Docs生成Swagger客户端
我见过这个Spring REST Docs - video 我们正在进行Spring启动项目，并使用springfox库生成Swagger-ui和swagger文档，如here所述 我们喜欢Spring Rest文档可以用来生成REST API文档，以及我们不需要在我们的Controller代码中添加像@ApiResponse或@ApiOperation这样的swagger注释 . 此外，文档... -
1 votesanswersviews
为现有NodeJS服务器生成Swagger文档
我花了很多时间，然后我看到了这个question on SO，最后一个答案是express-oas-generator似乎是一个很好的工具 . 成功生成了我的文档，但 POST 没有制作我的Payload文档，没有这个，一些开发人员可能认为我的 POST 不需要有效负载发送 我所做的就是遵循文档，使用API进行一些测试并使用POSTMAN调用方法 . express-oas-generator生... -
1 votesanswersviews
Swagger-ui不断提供示例petstore，而不是提供swagger.json
我按照说明使用swagger-jsdoc为我现有的节点API设置了swagger文档 . swagger.json正在正确提供，我在index.html的SwaggerUiBundle的url参数中添加了一个路径，如下所示： const ui = SwaggerUIBundle({ url: "https://my.domain:5292/swagger.json", dom... -
0 votesanswersviews
apiKey作为Swagger UI 2.0中的查询参数
Context ：将Swagger从1.2规范中的当前REST文档转换为2.0 Environment ：Java 8，swagger-maven-plugin 3.0.1，swagger annotations（com.wordnik） Where I am stuck ：我能够成功生成REST API文档 . 但是，REST API需要ApiKey作为Query参数 . 在1.2规范中，这是使... -
0 votesanswersviews
SwaggerUI NodeJs（流星）
我有一个带有REST API的流星应用程序https://atmospherejs.com/simple/json-routes . 现在我想用SwaggerUI记录我的API . 我已经在其他项目中使用过SwaggerUI，并且知道你必须创建一个yaml或json sepc文件，然后由SwaggerUI显示 . 所以现在我发现npm存在一些现有的swagger-ui包： https://www.... -
0 votesanswersviews
为SWAN单点应用程序添加cors，用于Swagger-ui
我正在运行一个NodeJS服务器，该服务器使用构建的Angular / dist文件夹为UI服务 . 在UI中我包含了swagger-ui，它正在加载一个swagger.json，* .json正在描述一个REST接口，并且在swagger-ui中你应该能够测试REST接口 . https://swagger.io/swagger-ui/ 项目结构 在server.js中，我在存储index.h... -
10 votesanswersviews
使用Swashbuckle和ASP.NET Identity限制对Swagger中某些API控制器的访问
所以，我开始使用Swagger . 我完全爱上了它的功能，但我对所有公开方法的可用性都有所怀疑 . 据我所知 - Swaschbuclke中包含的所有“auth”方法实际上都是关于API本身，但我不需要帮助 - 我的所有API都受API id /密钥对的保护 . 我想以某种方式利用ASP.NET身份（登录系统）来限制对API页面的访问（/ swagger / ui / index） . 有什么办... -
1 votesanswersviews
向Swagger添加自定义安全性
我是新手使用swagger作为我的UI来测试和调试并显示我的Web API项目的文档 . 在最近的一个项目（类型：ASP.NET Web API）中我遇到了一个问题，我的API没有任何安全性，因为它的界面对任何人都不清楚 . 但我需要保护昂首阔步的用户界面，因为每个人都可以通过在api的网址后添加“Swagger”来访问我的完整文档！ 由于我通过开箱即用的swashbulckle nuget-pa... -
3 votesanswersviews
优点与缺点：在 生产环境 环境中使用Swagger中间件
我正在使用Swagger构建高流量API，并且正在寻找在高流量 生产环境 环境中使用Swagger的建议 . 我的重点是性能和安全性 . 我已经看到很多在Node项目中实现Swagger的方法，其中批量使用两种方法： 1）使用npm-swagger-express-mw和npm-swagger-tools等中间件拦截您的路由，验证输入，生成默认错误响应并通过读取符合Swagger的yaml或JSO... -
1 votesanswersviews
使用路由属性和查询参数时，Web api2的Swagger文档
我有一个简单的Web API2项目，它使用swagger作为它的文档 . 给定一个简单的GET endpoints ，它使用路由参数和查询参数，例如： [HttpGet] [Route("api/v2/items/{itemid:int}")] public IHttpActionResult Getv2(int itemId, [FromUri(Name ="&qu... -
0 votesanswersviews
Swagger / Swashbuckle IdentityServer4隐式流程：401成功登录后出错？
我正在尝试将OAuth实施到我公司的某个项目中，但无法解决以下问题 . 我们使用 IdentityServer4 来实现我们自己的授权服务器，到目前为止工作正常 . 我想用OAuth保护的资源是一个利用 Swagger/Swashbuckle 的WebApi . 我按照 IdentityServer4 QuickStartExamples 配置服务器和本教程[使用Swagger，Swashbuck... -
0 votesanswersviews
MapHttpRoute到Swashbuckle Swagger UI使用自定义处理程序
我的网络api项目中有Swashbuckle . 我想只在用户试图点击swagger ui页面时才调用自定义处理程序 . 我不想将处理程序添加到管道 . 我认为这样的事情可能有效，但事实并非如此： config.MapHttpAttributeRoutes(); config.Routes.MapHttpRoute( name: "SwaggerUI",... -
7 votesanswersviews
Swagger UI 2.1坚持“获取资源列表”
我有一个最近创建的RESTful API，我不记得几个月后如何使用它 . 我决定用Swagger记录我的API，但是我疯了 . 我使用http://editor.swagger.io/创建了YAML文件，然后我将其转换为Swagger可以使用的JSON文件 . 当我将文件放入Swagger UI时，它只是停留在 fetching resource list: localhost/swagger.j... -
0 votesanswersviews
作为参数传递的swagger对象可以在swagger-ui中使用默认值吗？
我定义了一个以MyObject作为参数的路径 . MyObject具有猫和狗的属性 . 这些都有默认值 . 在swagger-editor中，该示例不显示默认值，但try-it-out确实创建了具有正确默认值的MyObject . 在swagger-ui中，我可以在模型下看到默认值，但在API中看不到 . 有没有办法设置这些默认值？ swagger：'2.0'info：title：传递对象，默认... -
1 votesanswersviews
带有swagger ui的@RequestParam带注释的方法没有显示描述
我试图模拟Swagger-UI，以便不仅修改"name"字段，还修改API输入参数的"Description"字段 . 这里有一个例子，似乎有人成功地使用了@ApiParam和@RequestParam：[link] 到目前为止，最接近修改描述字段的是以下内容，其中我在@RequestParam输入上单独使用“value”字段： 但是，每当我尝试在单个输入... -
3 votesanswersviews
Swagger（-ui）不显示操作
我有一个 Spring 天的网络应用程序，我已经加入了swagger和swagger-ui . 我添加了一个虚拟类来测试swagger： import com.wordnik.swagger.annotations.Api; import com.wordnik.swagger.annotations.ApiError; import com.wordnik.swagger.annotations... -
0 votesanswersviews
Swagger指定两次相同的路径
是否可以在一个由Swagger-UI呈现的API规范中出现多次相同的路径？ 我应该创建单独的api规范并加载两个Swagger-UI实例吗？处理这个问题的最佳方法是什么？ 对于前者我有一个名为/ oauth / token的 endpoints ，我希望用OAuth授权代码流的一组参数和带有不同参数集的client_credentials流的相同 endpoints / oauth / token... -
2 votesanswersviews
如何从Swagger UI中隐藏Spring Security OAuth2 endpoints ？
我有一个使用Spring Boot构建的API应用程序 . 我使用 swagger-springmvc v0.9.5插件和Swagger UI生成API方法的实时文档和交互前端 . 我最近向应用程序介绍了Spring安全性和OAuth . 这引入了Swagger UI中出现的更多部分： authorization-endpoint 在 /oauth/authorize 路径下有一堆HTTP操... -
1 votesanswersviews
Swagger UI {format}属性？
我正在看一个显示这个的Swagger UI： 我不知道 {format} "segment"是什么或它是什么 . 我想也许这与piece of Swagger documentation（在"Data Types" Headers 下）有关： 基元具有可选的修饰符属性格式 但是，我相信我已经在我自己的swagger.json内容中找到了这个 form... -
4 votesanswersviews
Swagger：常见的响应/有效负载对象，但每个API定义的数据不同？
表示具有基本字段（如消息，总元素，数据和状态）的通用响应/有效负载对象的最佳方法是什么？每个API之间的可变性是数据元素 . 例如，一个API可以用于权限，因此数据元素将包含一组权限 . 但对于另一个API，它将包含不同的对象类型数组 . 我的主要目标是重用有效负载对象并定义实际数据的下一个“层” . 我希望能够定义一个通用的数据类型 - 比如具有基本字段的“响应”，但我希望能够进一步为每个API... -
0 votesanswersviews
发布用于Google Cloud 终端的swagger doc的问题
我正在尝试为我的 Cloud endpoints 发布Swagger文档 . 我的应用程序是Python . 根据文档[1]： 1.）我从https://github.com/swagger-api/swagger-ui.git下载了存储库 . 2.）从下载的存储库中复制dist目录，并将其放入项目内的docs文件夹中 . 我创建了一个名为docs的新文件夹 . 3，）按照步骤3，项目名称应为F...