1---
2swagger: "2.0"
3info:
4 title: Swagger Sample
5 description: Sample API Playground.
6 version: 1.0.0
7basePath: /v1
8schemes:
9- http
10consumes:
11- application/vdn.sample.v1+json
12produces:
13- application/vdn.sample.v1+json
14
15paths:
16 /books:
17 get:
18 summary: List all books
19 operationId: listBooks
20 tags:
21 - books
22 responses:
23 200:
24 headers:
25 Link:
26 type: string
27 description: An array of books
28 schema:
29 type: array
30 items:
31 $ref: "#/definitions/Book"
32 default:
33 description: generic error response
34 schema:
35 $ref: "#/definitions/Error"
36
37definitions:
38 Book:
39 type: object
40 required:
41 - title
42 - summary
43 properties:
44 title:
45 type: string
46 example: Winnie the Pooh
47 summary:
48 type: string
49 example: Famous children's book
50 related_books:
51 type: array
52 items:
53 $ref: "#/definitions/Book"
54
55 Error:
56 type: object
57 readOnly: true
58 properties:
59 code:
60 type: integer
61 format: int64
62 example: 400
63 message:
64 type: string
65 example: Unexpected error
66 required:
67 - message
View as plain text