68 lines
1.2 KiB
YAML
68 lines
1.2 KiB
YAML
|
---
|
||
|
|
swagger: "2.0"
|
||
|
|
info:
|
||
|
|
title: Swagger Sample
|
||
|
|
description: Sample API Playground.
|
||
|
|
version: 1.0.0
|
||
|
|
basePath: /v1
|
||
|
|
schemes:
|
||
|
|
- http
|
||
|
|
consumes:
|
||
|
|
- application/vdn.sample.v1+json
|
||
|
|
produces:
|
||
|
|
- application/vdn.sample.v1+json
|
||
|
|
|
||
|
|
paths:
|
||
|
|
/books:
|
||
|
|
get:
|
||
|
|
summary: List all books
|
||
|
|
operationId: listBooks
|
||
|
|
tags:
|
||
|
|
- books
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
headers:
|
||
|
|
Link:
|
||
|
|
type: string
|
||
|
|
description: An array of books
|
||
|
|
schema:
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
$ref: "#/definitions/Book"
|
||
|
|
default:
|
||
|
|
description: generic error response
|
||
|
|
schema:
|
||
|
|
$ref: "#/definitions/Error"
|
||
|
|
|
||
|
|
definitions:
|
||
|
|
Book:
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- title
|
||
|
|
- summary
|
||
|
|
properties:
|
||
|
|
title:
|
||
|
|
type: string
|
||
|
|
example: Winnie the Pooh
|
||
|
|
summary:
|
||
|
|
type: string
|
||
|
|
example: Famous children's book
|
||
|
|
related_books:
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
$ref: "#/definitions/Book"
|
||
|
|
|
||
|
|
Error:
|
||
|
|
type: object
|
||
|
|
readOnly: true
|
||
|
|
properties:
|
||
|
|
code:
|
||
|
|
type: integer
|
||
|
|
format: int64
|
||
|
|
example: 400
|
||
|
|
message:
|
||
|
|
type: string
|
||
|
|
example: Unexpected error
|
||
|
|
required:
|
||
|
|
- message
|