-
2 votesanswersviews
混淆从proto文件创建swagger.json文件
我已经创建了一个原型文件,其中包含我打算生成的REST Web服务的所有必要消息和rpc函数 . 使用protoc-gen-swagger插件我已经设法将该原型文件编译成swagger.json文件并且一切看起来都很好,除了两件事,我似乎无法解决 . swagger.json文件中的所有定义都以我的proto文件包的名称为前缀 . 有没有办法摆脱这个? 我的消息的所有字段都是“可选的” .... -
2 votesanswersviews
如何在python烧瓶(restplus)中的GET请求中传递URL作为参数?
我正在使用python flask创建一个REST API . API已准备就绪,可以在我的localhost的端口号8000上运行 . 现在我打算给这个REST API一个用户友好的界面,我决定使用python - restplus . 我想在内部从5000上运行的swagger应用程序调用此服务(在8000上运行) 我能够创建API的基本结构(Swagger) . 代码如下所示: imp... -
1 votesanswersviews
使用Swagger API在JMETER中为所有请求显示相同的HTML响应
Jmeter响应数据不正确 API工具:Swagger类型:用于输出的Json Jmeter模板:“查看结果树” Exat响应数据没有进入JMeter,但是在Soap UI Exat Response数据中获得了JSON 可以帮助我获取Exat“响应数据”的JSON 运行脚本(Threads-1,Ramp Up period-1,Loop Count-1)后,下面是我在View Results T... -
0 votesanswersviews
IIS重写,排除文件夹和子文件夹 - Swagger案例
我有一个Web应用程序,在Azure上使用AspNetCore WebAPI AngularApp,在我的Web.Config中有基于本文的IIS重写规则:https://weblog.west-wind.com/posts/2017/Apr/27/IIS-and-ASPNET-Core-Rewrite-Rules-for-AspNetCoreModule 我想避免重写Swagger,所以我添加了... -
1 votesanswersviews
Swagger ...来自Mustache的查询参数属性访问
我正在使用带有swagger-codegen的Mustache来从定义生成模型实体,并从操作(路径部分)生成代码 . 每个操作都指定一个参数列表和其他参数属性 - 数据类型,描述,默认值,必需,最大值,示例等 . 除了'model'阶段之外,我无法解决如何访问除'required'属性之外的任何参数属性...如何在'api'阶段执行此操作? ......我'd like to be able to... -
0 votesanswersviews
Scala生成可选的swagger字段
使用swagger编辑器(http://editor.swagger.io/#/)为可选字段的定义生成客户端scala我希望这些字段的scala生成为Option [],但似乎并非如此 . 以Pet Store样品json为例:https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/json/... -
1 votesanswersviews
将Djoser URL与Swagger一起包含时出现类型错误
我的django-swagger正在使用我的API . 但是,当我尝试将Djoser urls包含到我的urlpatterns时,我得到以下回溯: Internal Server Error: /docs/ Traceback (most recent call last): File "/Users/bo/env/home365/lib/python3.6/site-package... -
1 votesanswersviews
将Swl特征添加到Swagger-UI
我一直在使用Swagger-UI来记录我的API并一直很喜欢它,但是我想知道是否在“现在试试”部分(当Swagger返回请求URL时,是否有办法同时显示CURL? 我想知道是否有人设计了一个hack来将其注入预先构建的Swagger-UI格式(因为我刚刚使用Swagger-Spec生成它) . -
0 votesanswersviews
Swagger UI生成错误的Curl命令
Swagger UI生成错误的Curl命令,粘贴在下面并且由于此查询字符串截断 卷曲-X GET http://domain:8080/v1/endpoint?access_token=affsfafasfa&type=1 -H "accept: application/json" -H "content-type: application/json"... -
0 votesanswersviews
Swagger docs在Rails中上传二进制文件不正确的curl命令
为我的api endpoints 创建一个Swagger文档 . 我有一个在终端上工作的curl命令 curl -X POST -b "http://localhost:3000/v0/users/4/avatar" -H "accept: application/json" -H "content-type: multipart/form-dat... -
8 votesanswersviews
需要为使用nodejs / express编写的现有应用程序创建api doc
我有一些用普通旧快递写的私人api . 是时候把它拿出来并提供一些api文档 . 我不想(至少还有)重写我的快速应用程序以将api文档集成到代码中 . 主要是因为我不确定使用什么框架或规范来记录我的api我真的不想锁定一个特定的东西 . 我想在我的api下提供doc作为子资源的一部分(即我不想运行不同的服务器或子域) . 也许'/ api / docs' . 一个加号也可以是我可以嵌入我的应用程序... -
2 votesanswersviews
Django REST Swagger可用于生成静态HTML文档吗? [关闭]
我正在开发一个新的Django REST Framework项目,我正在使用Django REST Swagger提供开箱即用的漂亮文档 . 但是,我想分享这个文档而无需启动升级机或类似的东西 . 我只想生成类似静态sphinx的文档,而不需要花哨的客户端功能 . 我不需要能够实际访问API endpoints . 我只想要一个用户友好的描述存在什么 endpoints ,他们接受/返回什么等 ... -
1 votesanswersviews
在启动Express应用程序之前,如何确保已在Swagger文件中记录API?
我的节点应用程序创建三个不同的快速服务器,每个服务器在不同的端口上进每个服务器都有一组不同的API,三个服务器之间有一些共同点 . 还有一个swagger.yaml文件,其中应包含要路由的任何API的文档 . 我想确保在启动应用程序之前,每个API都记录在此swagger文件中,如果任何API路由到服务器但未记录,则会使其失败 . 到目前为止,我已经尝试了各种中间件来基于swagger文档验证和路... -
0 votesanswersviews
使用swagger 0.9.1为Spring MVC项目生成REST API文档
对于我的项目,我想使用swagger生成REST API文档 . 我找到了一个示例app here 但是这个例子是使用0.5.2版本的swagger-springmvc . 此版本与我的Spring项目不兼容 . 有人可以指导我如何在 Spring 季MVC中集成swagger 0.9.1吗? 注意:我的不是一个 Spring 季启动应用程序 . -
15 votesanswersviews
使用Javadocs生成Swagger文档
我想为现有的一组RESTful API构建Swagger文档 . 我有以下要求: 离线生成Swagger文档(我使用http://kongchen.github.io/swagger-maven-plugin/) . 这个插件帮助我在编译期间生成Swagger文档 . 读取现有的Javadoc,以便可以在Swagger文档中使用它们 . 到目前为止使用上面的插件我能够实现第1点 . 所... -
2 votesanswersviews
更改swagger-ui的basePath
我使用swagger project create来为节点服务提供API . 我跟着these instructions . 我也在使用招摇工具来为swagger-ui服务 . 我想动态地将API的basePath及其文档从'/'和'/ docs'更改为routingPath和routingPath'/ docs' . 我能够改变我的swagger API规范的basePath,但我不知道如何更改... -
1 votesanswersviews
从swagger规范文件更新postman集合
我正在将一个swagger规范文件导入邮递员以创建一个集合,此时,按预期工作,并使用所有请求和子文件夹生成集合,很好!!但是当更新api时,我需要更新邮递员以根据新规范更新所有请求 . 我找不到像“更新”之类的动作 . 我正在尝试将新规范导入邮递员,他说: 集合APIName已存在 . 你想干什么? Replace 或 Import as copy 复制它是一个不可行的选项,然后我使用 rep... -
0 votesanswersviews
如何将 Headers 信息放在swagger json中
我从swagger文档中按照以下链接为我的其余api创建了swagger json . https://swagger.io/docs/specification/2-0/describing-request-body/ 在我的休息api中,我有请求body和类型的内容类型和授权的http标头,以及服务请求 . 我想知道是否有办法在swagger json中包含请求正文和http头信息?我没有在招... -
1 votesanswersviews
使用Swagger进行说明 - 使用泛型时无法生成文档资源模型
我面临的问题与该线程中描述的问题类似: Can Enunciate generate docs for an API that handles generic types? 我正在使用启用 spring 和swagger模块的enunciate 1.28 . 所以考虑一个抽象资源类,如: public abstract class AbstractResource<T> { ... -
1 votesanswersviews
如何使用swagger-js生成静态HTML文档?
我有一个集成了Swagger的RESTful API,因此现在可以使用浏览器指向该服务器并查看记录该API的Swagger UI . 我想使用swagger-js项目从服务器上的Swagger数据生成Javascript中的客户端SDK . 它似乎可以生成这个客户端SDK,我可以通过Chrome Developer Tools中的对象和功能来探索SDK对象 . 但是,我想以某种方式生成此客户端SD... -
4 votesanswersviews
如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面
我试图通过Swagger UI记录内部公司消费,在供应商产品(WSO2 ESB)中开发的现有API服务 . 供应商产品不支持招摇 . 我计划以编程方式检查/处理我的API服务的源代码(在供应商产品中编写),并生成.json或.yml格式的swagger定义文件的目录/文件夹/库 . 没关系,我可以做到 . 这些api defintion文件中的每一个都将在swagger UI中呈现得很好,我正在使... -
1 votesanswersviews
Swagger UI不会在POST中显示image / png内容
我有一个POST方法返回“image / png”内容的场景 . API在Postman中完美运行,我能够看到图像 . 我使用Swagger来记录我的API . 由于某种原因,“试用”功能会导致任何返回图像的POST方法崩溃 . 它冻结加载,我在浏览器控制台中看到以下内容: cannot parse JSON/YAML content swagger-ui-min-js:14 Uncaught... -
2 votesanswersviews
当新请求被开发人员更新到api时,如何更新Postman集合
我在Swagger中有我的API文档,它有不同的 endpoints 或请求 . 我使用Swagger中我的API的 swagger.json 链接将它们作为集合导入Postman,然后在那里添加测试用例 . 但我很困惑,如果开发人员向API添加更多请求,我如何导入新请求而不影响测试用例 . 例如:在一个案例中,我有一个API,其中包含65个从Swagger UI导入的请求和编写的测试用例 . 然... -
2 votesanswersviews
flask-swagger ID并返回一系列事物
我们正在使用flask-swagger来记录我们的Flask / Python REST API . 在很多情况下,我返回一个 a_name : schema: id: a_name properties: first_name: type: string description: first name ... -
0 votesanswersviews
swagger编辑器生成不会POST的typescript客户端
我已经使用位于http://editor.swagger.io的Swagger编辑器生成了一个Angular2打字稿客户端 . 虽然POST endpoints 永远不会被发送到服务器,但API适用于所有非 POST 类型的api endpoints . 到达生成的typescript中的以下方法,并且 console.log 语句显示正在设置标头,尽管实际上没有POST到服务器 . 这表明 t... -
7 votesanswersviews
将Swagger / OpenAPI生成的python服务器与现有的Flask应用程序集成
我有兴趣将 swagger-codegen 生成的Python服务器与现有的Flask应用程序集成 . swagger-codegen基于Swagger API specification中的Connexion库生成Python实现 . examples我发现所有人似乎都期望connexion.App管理整个 flask 应用程序 . import connexion app = connex... -
2 votesanswersviews
Swagger2配置类未在spring mvc中加载
我正在为我的Spring REST项目设置swagger2文档 . 但是当我尝试执行http://localhost:8085/swagger-ui.html返回空页时 . 问题是我的bean类没有被我的Spring MVC应用程序加载,它不是一个 spring 启动应用程序 . 以下是我的swagger2配置类 @Configuration @EnableSwagger2 @EnableWebM... -
0 votesanswersviews
如何使用Swagger2生成Spring-boot REST API文档?
我试图使用swagger2生成我的Spring-boot应用程序的REST API文档 . 这是我的application.properties文件内容: server.port = ${port:8082} server.contextPath=/myServicePath spring.h2.console.enabled=true logging.level.org.hibernate.SQ... -
2 votesanswersviews
如何使用swagger-ui模块在我的MEAN堆栈项目中显示Swagger JSON文件?
我是NodeJS和AngularJS的新手,所以我可能会接近这个完全错误,但值得一提...... 我正在尝试使用swagger-ui Node module以具有交互性的Swagger-ish样式显示我的API文档 . 我希望通过传入我自己的Swagger JSON文件(在 public/assets/my-swagger.json 中托管)在我的NodeJS应用程序中执行此操作 . 我假设我可以... -
2 votesanswersviews
Swagger-UI没有正确显示
为什么我的Swagger UI看起来不同? This is what I have: This is what I would like to have: 为了让Swagger-UI正常工作,我所做的就是下载项目(https://github.com/swagger-api/swagger-ui),获取dist文件夹中的所有内容并将其放入动态Web项目的webapp文件夹中 . 执行此操作后,...