天道酬勤,学无止境

apiary

尝试使用 API Blueprint 中的数据结构来描述请求和响应(Trying to describe the request and response using Data Structures in API Blueprint)

问题 我正在尝试使用规范的新 Attributes 和 DataStructures 部分来记录带有 API Blueprint 的端点。 我的请求负载如下所示: { "url": "http://requestb.in/11v7i7e1", "active": true, "types": [ { "name": "sales", "version": "2.0" }, { "name": "products", "version": "2.0" } ] } 我的响应负载看起来像这样: { "data": { "id": "dc85058a-a683-11e4-ef46-e9431a15be8c", "url": "http://requestb.in/11v7i7e1", "active": true, "types": [ { "name": "products", "version": "2.0" }, { "name": "sales", "version": "2.0" } ] } } 我尝试了以下 API 蓝图降价: FORMAT: 1A # Vend REST API 2.0 # Group Webhooks ## api/2.0/webhooks [/webhooks] ### List all Webhooks [GET] Returns a list of

2021-11-29 17:34:54    分类:技术分享    api   apiblueprint   apiary.io   apiary   MSON

Trying to describe the request and response using Data Structures in API Blueprint

I'm trying to document an endpoint with API Blueprint, using the new Attributes and DataStructures sections of the spec. My request payload looks like this: { "url": "http://requestb.in/11v7i7e1", "active": true, "types": [ { "name": "sales", "version": "2.0" }, { "name": "products", "version": "2.0" } ] } My response payload looks something like that: { "data": { "id": "dc85058a-a683-11e4-ef46-e9431a15be8c", "url": "http://requestb.in/11v7i7e1", "active": true, "types": [ { "name": "products", "version": "2.0" }, { "name": "sales", "version": "2.0" } ] } } I tried the following API Blueprint

2021-11-21 17:46:02    分类:问答    api   apiblueprint   apiary.io   apiary   MSON

在 API 蓝图中表示文件上传(Represent File Uploads in API Blueprints)

问题 我们有一个 API 端点,可以在其中上传图像文件以及文件名(字符串)和描述(字符串)。 Apiary / API Blueprints 不允许我有类似的东西: + Request (multipart/form-data) + Headers Authorization: [key] + Attributes + name (string, required) - A human-readable name of the Catalog Item + description (string, optional) - A human readable description of the Catalog Item + image (file, optional) - An image file corresponding to the Catalog Item 我得到: base type 'file' is not defined in the document 有没有办法在 API Blueprints 中表示多部分/表单数据,例如上述内容?

2021-10-18 19:10:16    分类:技术分享    apiblueprint   apiary.io   apiary

Apiary.io 和/或 API Blueprint 是否支持 API 版本控制?(Does Apiary.io and/or API Blueprint support api versioning?)

问题 api blueprint 或 Apiary.io 是否支持对 API 进行版本控制的概念? 特别是,我通过 URI 对我的 API 进行版本控制,如下所示: GET /api/v2/SomeResource/ 在上面的示例中,这意味着我正在调用 API 的第 2 版(“v2”)。 api蓝图支持这个吗? 如何记录给定操作或整个 API 的多个版本? 回答1 您可以使用HOST标头来表示: HOST: http://example.com/api/v2将使用/api/v2为所有资源添加前缀。 在 API 蓝图中,如果您使用 URL 前缀,则 API 被认为是不同的,因此您应该为它们使用不同的蓝图。 如果您使用带有版本后缀的媒体类型来执行此操作,您只需在标头中指定正确的Content-Type ,它们将被正确用于模拟服务器中的内容协商。

2021-09-29 03:07:09    分类:技术分享    rest   apiblueprint   apiary

MSON在蓝图中描述对象属性(MSON to describe object attributes in blueprint)

问题 我有一个类似于这里描述的问题。 我有一个看起来像这样的 JSON: { "photos": [ { "key": "y37dmj10jkwof/moOIUB8912JKVgh", "caption": "A world of gamers.", "tags": [ "game", "japan" ], "attributes": { "copyright": true, "use": [ "public", "private" ] } } ] } 我正在尝试使用 MSON 描述属性,以呈现蓝图。 但是,我并不成功。 这是我的尝试: + Attributes (required, object) + photos (required, array) + (object) + key (required, string) - Photo key + caption (required, string) - Photo caption + tags (required, array) + game (string) + japan (string) + attributes (required, object) + (object) + copyright: true (required, boolean) + uses (required, array) + public

2021-09-23 18:36:38    分类:技术分享    apiblueprint   apiary.io   apiary   MSON

如何将 API 版本添加到 Apiary Mock Server(How to add API version to Apiary Mock Server)

问题 有什么方法可以将 API 版本添加到 Apiary Mock Server? 例:http://private-XXXXX-apiname.apiary-mock.com/ v1 /嘲笑/ 1?学校ID = 1 回答1 是的,在声明HOST ,您可以为其附加后缀,然后将其作为前缀传播到所有资源: FORMAT: 1A HOST: http://api.example.tld/v1/

2021-09-20 23:53:33    分类:技术分享    apiary.io   apiary

使用 Apiary 创建模拟服务 API(Create Mock Service API using Apiary)

问题 我正在尝试创建用于测试目的的模拟 api 服务。 我们已经在另一个团队中使用 Apiary,所以我从那里开始。 到目前为止,我注意到如果我想要两个单独的调用需要模拟两个请求。 例如,要获取 ID 为 1 和 2 的注释,需要明确写出如下响应: /notes/1 /notes/2 有没有办法避免这种情况? 不可否认,我仍在努力创建蓝图。 回答1 看看 private-e9e59-pingdomcheck.apiary-mock.com/v1/gists/1。 这里的数字1是{id} 。 您当然只能得到一般定义的响应(就像我使用 id 42 一样)。 现在在 MSON 中有更多的事情要做。 一旦发布,请求中不同参数的不同回复将是可能的。

2021-09-18 17:42:55    分类:技术分享    apiblueprint   apiary.io   apiary

How to add API version to Apiary Mock Server

Is there any way to add API version to Apiary Mock Server? Ex.: http://private-XXXXX-apiname.apiary-mock.com/v1/mocks/1?school_id=1

2021-09-05 11:05:49    分类:问答    apiary.io   apiary

MSON to describe object attributes in blueprint

I have an issue similar to what is described here. I have a JSON that looks like this: { "photos": [ { "key": "y37dmj10jkwof/moOIUB8912JKVgh", "caption": "A world of gamers.", "tags": [ "game", "japan" ], "attributes": { "copyright": true, "use": [ "public", "private" ] } } ] } and I am trying to describe the attributes using MSON, to render the blueprint. However, I am not successful at it. Here is my attempt: + Attributes (required, object) + photos (required, array) + (object) + key (required, string) - Photo key + caption (required, string) - Photo caption + tags (required, array) + game

2021-06-28 18:52:30    分类:问答    apiblueprint   apiary.io   apiary   MSON

Does Apiary.io and/or API Blueprint support api versioning?

Does api blueprint or Apiary.io support the notion of versioning your API? In particular, I'm versioning my API via the URI like this: GET /api/v2/SomeResource/ In the example above, this means I'm calling version 2 ("v2") of the API. Does api blueprint support this? How can I document multiple versions of a given action or the entire API?

2021-06-21 20:20:40    分类:问答    rest   apiblueprint   apiary