-
7 votesanswersviews
使用golang注释生成Swagger规范
我正在尝试使用Swagger为golang编写的REST API创建文档 . 我一直在遵循本指南:https://goswagger.io/generate/spec.html这样做并且能够从我的主文件中的注释创建json文件,但是我不知道如何创建将转换为实际的swagger规范的.yaml文件 . 我按照页面上的说明操作,并将 //go:generate swagger generate spe... -
1 votesanswersviews
如何为REST API生成Swagger文件
我的要求是为给定的ReST API URL生成Swagger文件 . 我使用POSTMAN客户端调用了下面提到的URL,它工作正常 . 但是,要在Informatica中使用此URL,需要将关联的Swagger文件设置为json或yaml格式 . 我只是ReST API的最终用户,并且不知道它的代码 . 以下是使用的网址 . https://app.informaticaondemand.com/... -
0 votesanswersviews
如何将服务器内的客户端代码与swagger和spring boot框架集成
我是整个微服务领域的新手,但我的任务是开发微服务 . 使用swagger(现在是OpenAPI)创建规范,生成的代码在spring boot框架中 . 我的具体问题,可以转换为更通用的问题 . 假设有两个微服务 . 让我们称它们为“令牌服务”和“黑名单服务” . 客户端从“令牌服务”请求令牌,并且它将检查“黑名单服务”以知道用户是否已被列入黑名单 . 如果没有列入黑名单,客户将获得一个令牌;否则请... -
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.... -
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
升级Swagger打破了Spring Cloud(Eureka,Zuul,Ribbon)
我有两个Spring Boot应用程序,一个用作另一个的反向代理 . 我正在使用Spring Boot(1.4.1.RELEASE),Spring Cloud(Camden.SR1) . 我使用的是Swagger 2.5.0,一切都按预期工作 . 我的BootA应用程序托管了Eureka Server并包含Zuul映射,成功地将收到的请求转发到BootB应用程序 . 但是,如果我将Swagger升... -
2 votesanswersviews
我可以从现有的Java代码中获取Swagger文档吗?
在 Swagger 我绝对是新的,我有以下疑问: 我知道通常我必须在代码我的REST API之前创建Swagger文档并使用此文档来创建我的API(我知道从Swagger编辑器我也可以自动生成我的API服务器) . 我的问题是以下一个: 我正在开发一个实现我的REST API的Java应用程序(Spring Boot应用程序) . 我想使用Swagger来创建我的API文档 . 有办法自动完成吗?... -
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规范中,这是使... -
3 votesanswersviews
优点与缺点:在 生产环境 环境中使用Swagger中间件
我正在使用Swagger构建高流量API,并且正在寻找在高流量 生产环境 环境中使用Swagger的建议 . 我的重点是性能和安全性 . 我已经看到很多在Node项目中实现Swagger的方法,其中批量使用两种方法: 1)使用npm-swagger-express-mw和npm-swagger-tools等中间件拦截您的路由,验证输入,生成默认错误响应并通过读取符合Swagger的yaml或JSO... -
1 votesanswersviews
如何将我的自定义json转换为swagger 2.0 json
我很擅长招摇文件 . 我们为RESTFul Web服务开发了一个用于进度语言的现有项目 . 基于资源的不同url以application / json格式消耗和生成 . 我们的资源网址之一的输入和输出json格式如下: 要求: { "request": { "companyNumber": 5000, "operat... -
1 votesanswersviews
Swagger响应标头设置
我试图写一个swagger json-schema,响应产生其中一个 png图片 jpeg图片 gif图片 字符串 那么,我应该如何设置响应头内容类型以及生成MIME类型? enter link description here -
4 votesanswersviews
从Swagger定义生成样本请求和响应
我想从一个swagger定义文件(yaml / json)生成一个示例请求和响应 . 目的是删除这些API . 不幸的是,我没有管理员权限来安装swagger编辑器的生成服务器列表中列出的任何服务器框架 . 我也尝试用soapui(5.x)和ready api来模拟它,但是它们都无法解析定义文件的响应对象中的模式引用 - 例如:"responses":{"200&qu... -
1 votesanswersviews
Swagger - 如何编写常见的响应字段?
我有几个API,所有这些API都返回JSON,其中包含一个名为 success 的布尔字段 . API 1 {"success": true, "data": "some data"} API 2 {"success": false, "error": "error message&q... -
0 votesanswersviews
作为参数传递的swagger对象可以在swagger-ui中使用默认值吗?
我定义了一个以MyObject作为参数的路径 . MyObject具有猫和狗的属性 . 这些都有默认值 . 在swagger-editor中,该示例不显示默认值,但try-it-out确实创建了具有正确默认值的MyObject . 在swagger-ui中,我可以在模型下看到默认值,但在API中看不到 . 有没有办法设置这些默认值? swagger:'2.0'info:title:传递对象,默认... -
4 votesanswersviews
Swagger:常见的响应/有效负载对象,但每个API定义的数据不同?
表示具有基本字段(如消息,总元素,数据和状态)的通用响应/有效负载对象的最佳方法是什么?每个API之间的可变性是数据元素 . 例如,一个API可以用于权限,因此数据元素将包含一组权限 . 但对于另一个API,它将包含不同的对象类型数组 . 我的主要目标是重用有效负载对象并定义实际数据的下一个“层” . 我希望能够定义一个通用的数据类型 - 比如具有基本字段的“响应”,但我希望能够进一步为每个API... -
17 votesanswersviews
多态性中的“鉴别器”,OpenAPI 2.0(Swagger 2.0)
引用OpenAPI 2.0, Schema Object或Swagger 2.0, Schema Object,以及 discriminator 字段的定义为: 添加对多态性的支持 . 鉴别器是架构属性名称,用于区分继承此架构的其他架构 . 必须在此模式中定义使用的属性名称,它必须位于必需的属性列表中 . 使用时,值必须是此架构的名称或继承它的任何架构 . My confusions/ que... -
2 votesanswersviews
如何链接到Swagger中的另一个 endpoints
我正在为未来的公共API编写Swagger规范,需要非常详细和干净的文档 . Is there a way to reference/link/point to another endpoint at some other location in the swagger.yml file? 例如,以下是我想要实现的目标: paths: /my/endpoint: post: ... -
0 votesanswersviews
Swagger UI - 无需托管即可将编辑器中的JSON规范读入UI
我试图通过在Swagger编辑器中编写文档然后将其加载到Swagger UI中来使用Swagger记录我的API . 我使用了编辑器并下载了我的JSON文件,然后更改了UI中的/dist/index.html文件,使用以下命令指向我的本地文件: var spec = "file:///Users/user1/Desktop/swagger.json"; if (url &... -
0 votesanswersviews
如何使用自己的swagger-ui和Liberty JSON生成的内容
有一个内部Liberty swagger-ui,它对我来说很好,但实际上我们需要制作自己的招摇布局,我的意思是把我们的徽标和公司名称......等等 . This is what we get when calling https://localhost:9443/ibm/api/docs with basic swagger-ui 但是当我们使用浏览器网址并粘贴 https://localho... -
1 votesanswersviews
Rails:记录使用swagger-blocks消耗json params的post endpoint?
在rails中使用swagger-block,我会记录一个消耗单个json主体的post endpoints ,例如: { "id":"1", "name": "bill", "age":"22" } 无论我做什么,我的测试都说我的设置不是有效的Swagger 2.0 JSON模... -
0 votesanswersviews
将REST服务的完整响应作为输入发送到SOAP UI中的另一个REST服务
我们要求验证REST模式定义 . 我们有一个REST服务 endpoints R1,它在执行GET调用时返回一个json模式作为响应 . 我们需要将整个响应json模式作为输入发送到另一个REST服务R2以进行POST调用 . 我们有2个方案需要处理 a)R1返回正常的JSON模式b)R1以JSON格式返回Swagger定义 . 当R1返回其中包含多个其他REST API endpoints 的S... -
1 votesanswersviews
在同一 endpoints 支持两个不同的请求主体
我需要为同一个 endpoints 和相同的方法(POST)支持两种请求体 . 在Swagger有可能吗? 这很重要,因为两个请求体都是有效的,用户可以发送其中任何一个 . 进一步来说, RequestBody 1: { param1: value1 param2: value2 param3: { param3Key1: x1 param... -
0 votesanswersviews
在apache cxf中将swagger挂钩到应用程序时出现异常
.... <servlet> <servlet-name>jersey</servlet-name> <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class> <in... -
11 votesanswersviews
将JSON转换为与Swagger 2.0兼容的JSON Schema draft 4
我已经获得了REST API生成的一些JSON文件,这些文件具有大量属性 . 我为这个API创建了一个Swagger 2.0定义,需要为它提供相应的响应模式 . 主要问题:这个JSON文件有很多属性 . 这需要花费很多时间,如果我手动编写模式,我会犯很多错误 . 它不是我需要描述的唯一API . 我知道有一些工具可以将JSON转换为JSON模式但是,如果我没有弄错,Swagger只有$ refs到... -
0 votesanswersviews
Swagger / Swashbuckle显示“未知响应类型”
我正在创建一个C#ASP.NET Core 2.0 REST API,大部分都进展顺利 . 它使用MVC路由来生成REST API . 控制器非常简单 . // POST: api/Volume/{zoneID}/Set/{volume} [HttpPost("{zoneId:int}/[action]/{volume:int}", Name = "Set&q... -
2 votesanswersviews
Lib根据Swagger API定义检查JSON有效负载是否有效
我正在使用swagger来定义我的API和API网关来托管这个API . 我发现以下lib(see here)将我的API定义导入AWS并自动创建API(模型, endpoints 等) . 它's cool. But, it'无法基于模型验证请求(在Swagger定义中定义) . 这意味着您可以发送没有必填字段的JSON有效负载 . 我不想编写node.JS代码来检查格式,因为它对于架构更新来说... -
0 votesanswersviews
AWS API GATEWAY - 使用Swagger模板导入和导出API
我用AWS API Gateway做了几周的努力 . 我在我的API网关控制台中使用了客户端证书和自定义lambda授权程序,我的API工作版本 . 我试图导出到一个swagger文件,以便在同一AWS账户中作为不同的API导入,但导入的API不起作用 . 所有 endpoints 在“资源”面板中都运行良好,功能“test”但是当我尝试部署一个阶段时,它不起作用 . swagger导入和导出工... -
1 votesanswersviews
Swagger自定义模型
我使用swagger和spring boot为我的对象自动生成API文档 . 但是我正在使用@jsonAnyGetter @jsonAnySetter动态地将字段添加到我的json响应中 . 如 public class SomeResponse { //Standard part picked up by swagger public String field1; pu... -
1 votesanswersviews
void操作需要在assertj-swagger中使用'produces' swagger定义
我有以下Spring Boot(1.3.1) @RestController 定义: @RequestMapping(value = "/blah", method = DELETE) @ResponseStatus(NO_CONTENT) public void blah() {...} 并使用assertj-swagger来验证上面的以下swagger规范: '/blah... -
4 votesanswersviews
如何用Swagger描述“ModelAttribute”的最佳方法
我正在尝试将Swagger2集成到基于Spring Boot的应用程序中 . 问题是招摇不考虑模型属性 . @GetMapping(value = "/events", produces = MediaType.APPLICATION_JSON_VALUE) public PagedResources<EventResource> getEvents( ...