This repository has been archived by the owner on Apr 16, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathapiary.apib
309 lines (253 loc) · 11 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
FORMAT: 1A
HOST: https://api.apiblueprint.org
# API Blueprint API
API Blueprint API provides the access to core API Blueprint tools "as a service".
## Authentication and Rate Limiting
The access to the service does not require authentication; however it is rate-limited.
## Media Types
### Blueprint
```
text/vnd.apiblueprint+markdown
```
API Blueprint as defined in its [specification](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md).
### Blueprint AST
```
application/vnd.apiblueprint.ast.raw+json
application/vnd.apiblueprint.ast.raw+yaml
```
Serialized API Blueprint AST is represented either in its JSON or YAML format as defined in [API Blueprint AST Serialization Media Types](https://github.com/apiaryio/api-blueprint-ast).
### Parse Result
```
application/vnd.apiblueprint.parseresult.raw+json
application/vnd.apiblueprint.parseresult.raw+yaml
```
Result of API Blueprint parsing operation. This media types includes Blueprint AST media types and additional information – parser source code annotations (warnings and errors). Defined in [Parse Result Media Types](https://github.com/apiaryio/api-blueprint-ast/blob/master/Parse%20Result.md).
### Resource State Representation
```
application/hal+json
```
Where applicable this API uses the [HAL+JSON](https://github.com/mikekelly/hal_specification/blob/master/hal_specification.md) media-type to represent resources states and provide available affordances.
## Error States
The common [HTTP Response Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md) are used.
# Group API
## Service Root [/]
API Blueprint API entry point.
This resource does not have any attributes, instead it provides list of available affordances.
### Affordances
- `parse` - Parse an API Blueprint into AST
See _Blueprint Parser_ resource's _Parser_ action for details.
- `compose` - Composes an API Blueprint from an AST
See _Blueprint Composer_ resource's _Compose_ action for details.
### List [GET]
+ Response 200 (application/hal+json)
+ Headers
Link: <http://docs.apiblueprintapi.apiary.io>; rel="profile"
+ Body
{
"_links": {
"self": { "href": "/" },
"parse": { "href": "/parser" },
"compose": { "href": "/composer" },
}
}
# Group Blueprint Manipulation
## Blueprint Parser [/parser]
API Blueprint parsing as provided by the [Snow Crash](https://github.com/apiaryio/snowcrash) reference parser.
### Parse [POST]
Parse a blueprint (`text/vnd.apiblueprint+markdown`) into a serialized API Blueprint AST (`application/vnd.apiblueprint.ast.raw+json` or `application/vnd.apiblueprint.ast.raw+yaml`). The serialized Blueprint AST is returned alongside with any parser parser annotations in the form of a Parser Result (`application/vnd.apiblueprint.parseresult.raw+json` or `application/vnd.apiblueprint.parseresult.raw+yaml`).
+ Request JSON Parser Result (text/vnd.apiblueprint+markdown; version=1A; charset=utf-8)
+ Headers
Accept: application/vnd.apiblueprint.parseresult.raw+json
+ Body
# GET /message
+ Response 200 (text/plain)
Hello World!
+ Response 200 (application/vnd.apiblueprint.parseresult.raw+json; version=1.0)
{
"_version": "1.0",
"ast": {
"_version": "2.0",
"metadata": [],
"name": "",
"description": "",
"resourceGroups": [
{
"name": "",
"description": "",
"resources": [
{
"name": "",
"description": "",
"uriTemplate": "/message",
"model": {},
"parameters": [],
"actions": [
{
"name": "",
"description": "",
"method": "GET",
"parameters": [],
"examples": [
{
"name": "",
"description": "",
"requests": [],
"responses": [
{
"name": "200",
"description": "",
"headers": [
{
"name": "Content-Type",
"value": "text/plain"
}
],
"body": "Hello World!\n",
"schema": ""
}
]
}
]
}
]
}
]
}
]
},
"error": null,
"warnings": []
}
+ Request YAML Parser Result (text/vnd.apiblueprint+markdown; version=1A; charset=utf-8)
+ Headers
Accept: application/vnd.apiblueprint.parseresult.raw+yaml
+ Body
# GET /message
+ Response 200 (text/plain)
Hello World!
+ Response 200 (application/vnd.apiblueprint.parseresult.raw+yaml; version=1.0)
_version: 1.0
ast:
_version: 2.0
metadata:
name:
description:
resourceGroups:
- name:
description:
resources:
- name:
description:
uriTemplate: "/message"
model:
parameters:
actions:
- name:
description:
method: "GET"
parameters:
examples:
- name:
description:
requests:
responses:
- name: "200"
description:
headers:
- name: "Content-Type"
value: "text/plain"
body: "Hello World!\n"
schema:
error: null
warnings: []
## Blueprint Composer [/composer]
API Blueprint AST Media Types to API Blueprint conversions as provided by the [Matter Compiler](https://github.com/apiaryio/matter_compiler) tool.
### Compose [POST]
Convert a serialized API Blueprint AST (`application/vnd.apiblueprint.ast.raw+json` or `application/vnd.apiblueprint.ast.raw+yaml`) into API Blueprint (`text/vnd.apiblueprint+markdown`).
+ Request (application/vnd.apiblueprint.ast.raw+yaml; version=2.0)
_version: 2.0
metadata:
name:
description:
resourceGroups:
- name:
description:
resources:
- name:
description:
uriTemplate: "/message"
model:
parameters:
actions:
- name:
description:
method: "GET"
parameters:
examples:
- name:
description:
requests:
responses:
- name: "200"
description:
headers:
- name: "Content-Type"
value: "text/plain"
body: "Hello World!\n"
schema:
+ Request (application/vnd.apiblueprint.ast.raw+json; version=2.0)
{
"_version": "2.0",
"metadata": [],
"name": "",
"description": "",
"resourceGroups": [
{
"name": "",
"description": "",
"resources": [
{
"name": "",
"description": "",
"uriTemplate": "/message",
"model": {},
"parameters": [],
"actions": [
{
"name": "",
"description": "",
"method": "GET",
"parameters": [],
"examples": [
{
"name": "",
"description": "",
"requests": [],
"responses": [
{
"name": "200",
"description": "",
"headers": [
{
"name": "Content-Type",
"value": "text/plain"
}
],
"body": "Hello World!\n",
"schema": ""
}
]
}
]
}
]
}
]
}
]
}
+ Response 200 (text/vnd.apiblueprint+markdown; version=1A)
# /message
## GET
+ Response 200 (text/plain)
Hello World!