/
examples.md
186 lines (165 loc) · 3.65 KB
/
examples.md
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
# Examples
## API Description Formats
### API Blueprint Example
This shows an example of the parse results of an API Blueprint. Here is a very minimal example API Blueprint.
```markdown
# My API
## Foo [/foo]
```
When this document is parsed, it returns a serialization of API Elements that looks like the following.
```json
{
"element": "parseResult",
"content": [
{
"element": "category",
"meta": {
"classes": {
"element": "array",
"content": [
{
"element": "string",
"content": "api"
}
]
},
"title": {
"element": "string",
"content": "My API"
}
},
"content": [
{
"element": "category",
"meta": {
"classes": {
"element": "array",
"content": [
{
"element": "string",
"content": "resourceGroup"
}
]
},
"title": {
"element": "string",
"content": ""
}
},
"content": [
{
"element": "resource",
"meta": {
"title": {
"element": "string",
"content": "Foo"
}
},
"attributes": {
"href": {
"element": "string",
"content": "/foo"
}
},
"content": []
}
]
}
]
}
]
}
```
### Swagger / OpenAPI Format Example
This shows an example of the parse results of a Swagger document.
```json
{
"swagger": "2.0",
"info": {
"title": "My API",
"version": "1.0.0"
},
"paths": {
"/foo": {}
}
}
```
When this document is parsed, it returns a serialization of API Elements that looks like:
```json
{
"element": "parseResult",
"content": [
{
"element": "category",
"meta": {
"classes": {
"element": "array",
"content": [
{
"element": "string",
"content": "api"
}
]
},
"title": {
"element": "string",
"content": "My API"
}
},
"content": [
{
"element": "resource",
"attributes": {
"href": {
"element": "string",
"content": "/foo"
}
},
"content": []
}
]
}
]
}
```
As you can see, Swagger and API Blueprint both convey the same information resulting in almost the same parse results. This shows the importance of querying the results rather than looking for specific paths in the document.
## Data Structure
This section shows what individual and specific data structures look like when converted to API Elements. In the context of an API description or parse results, these structures will be nested within the document.
If you have an [MSON][] definition like the one below.
```markdown
# My List (array)
- 1 (number)
- 2 (number)
- 3 (number)
```
When the structure is parsed, it returns a serialization of API Elements that looks like:
```json
{
"element": "array",
"meta": {
"id": {
"element": "string",
"content": "My List"
}
},
"content": [
{
"element": "number",
"content": 1
},
{
"element": "number",
"content": 2
},
{
"element": "number",
"content": 3
}
]
}
```
And when it is converted to JSON, it looks like:
```json
[1, 2, 3]
```
[MSON]: https://github.com/apiaryio/mson