openapi

10热度

1回答

我有一个路径，它为每个http方法使用几乎具有相同属性的复杂模型。问题是我想为PUT和POST的请求定义一些所需的属性，而GET响应中不需要属性（因为服务器始终返回所有属性，并且在文档的其他地方提到了它）。我创建了一个简单的猫API来演示我所尝试过的。这个想法是，对于GET响应，响应模型没有任何标记，但是PUT的请求必须有一个猫的名字。 swagger: "2.0" info: t

0热度

2回答

当我请求url时，部署的Google Endpoints Quickstart应用程序给出错误消息？

我正在遵循标准环境中App Engine上Cloud端点框架的快速入门。我已经部署了示例API。当我打开https://[my-project].appspot.com/我得到的错误信息： Error: Not Found. The Requested URL/was not found on this server 该日志显示的消息： No Handlers matched this url

0热度

1回答

如何使用OpenAPI规范

读取此post（请参阅：3如何在使用OpenAPI（Swagger）规范描述REST API时使用单一定义...），您可以注意如何使用OpenAPI使用readOnly属性保留一个资源表示，用于添加/更新并获取资源，而不是使用一个表示获取（GET集合项），另一个用于添加（POST集合）。例如，在以下用户单一表示中，ID是是只读属性，这意味着在创建用户时不会在表示中发送它，它将在用户检索时出现在表示

4热度

1回答

允许招摇查询参数是字符串或者整数

在使用swagger2（OpenAPI的）构建一个REST API的阵列，我想允许查询参数station_id支持下列： station_id = 23（返回站23）？station_id = 23,45（返回站23和45）？station_id = [3:14]（返回站3至14）？station_id = 100％（％S充当通配符如此返回像1001, 10049等的东西。）我使用下面招摇

1热度

1回答

如何在OpenAPI（Swagger）中为同一路径定义不同的查询参数？

我正在使用Swagger Codegen启动REST服务。我需要针对不同的参数有不同的回应。例如：<baseURL>/path可以使用?filter1=或?filter2=，这些参数应产生不同的响应消息。我希望我的OpenAPI YAML文件分别记录这两个查询参数。这可能吗？

4热度

1回答

撰写使用多种内容类型的swagger文档，例如应用程序/ JSON和应用程序/ x-www-form-urlencoded（无重复）

我正在寻找一种优雅的方式来定义一个可以使用JSON数据以及表单数据的api。下面的代码片段很有用，但它不够高雅，并且需要后端中的所有丑陋代码。有没有更好的方法来定义这个？什么现在的工作： paths: /pets: post: consumes: - application/x-www-form-urlencoded - applicati

2热度

1回答

如何使用Swagger Codegen TypeScript提取客户端

是否有人成功使用Swagger代码生成器来创建可在浏览器内使用的TypeScript提取客户端？我试图在使用TypeScript的React应用程序中使用生成的API客户端。虽然我已经成功地生成客户端（即api.ts文件），我越来越挂在它开始用下面的进口事实： import * as querystring from "querystring"; import * as url from "u

0热度

1回答

PayPal支付API的Swagger格式

我是OpenAPI的新手，我需要一些帮助来创建PayPal的payment API的基本招摇档案，以从我们的平台创建支付。注意：OAuth已配置。下面是一个基本的招摇文件，但我不知道在哪里添加paymet request information（即意图，付款人，交易等）为： { "swagger": "2.0", "info": { "description":

2热度

1回答

如何在OpenAPI（Swagger）中指定多个404原因？

我正在为嵌套资源（属于传递的内容）定义路径。如果客户端得到404，那么可能是因为未找到传递ID，或者传递未包含任何指定类型的内容。如何建模使用OpenAPI（YAML）？我有现在这个权利... paths: '/deliveries/{id}/content/articles': get: summary: Retrieves articles from a d

1热度

2回答

OpenAPI/JSON Schema中的多继承/组合

在OpenAPI中，使用allof可以实现继承。例如，在this example： "definitions": { "Pet": { "type": "object", "allOf": [ { "$ref": "#/definitions/NewPet" # <--- here }, [...] ]