Instantly share code, notes, and snippets.

Embed
What would you like to do?
サンプル 本棚アプリケーション
swagger: "2.0"
info:
description: "This is a sample server Bookshelf server. 本棚アプリケーションのサンプル。"
version: "1.0.0"
title: "Swagger Bookshelf"
termsOfService: "http://www.example.com/terms/"
contact:
email: "hoge@example.com"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "www.example.com"
basePath: "/v1"
tags:
- name: "book"
description: "Everything about your Books"
externalDocs:
description: "Find out more"
url: "http://swagger.io"
- name: "user"
description: "Operations about user"
externalDocs:
description: "Find out more about our bookshlef"
url: "http://swagger.io"
schemes:
- "https"
- "http"
paths:
/book:
post:
tags:
- "book"
summary: "Add a new book to the bookshlef"
description: ""
operationId: "addBook"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Book object that needs to be added to the bookshelf"
required: true
schema:
$ref: "#/definitions/Book"
responses:
405:
description: "Invalid input"
security:
- bookshelf_auth:
- "write:books"
- "read:books"
x-swagger-router-controller: "Book"
put:
tags:
- "book"
summary: "Update an existing book"
description: ""
operationId: "updateBook"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Book object that needs to be added to the bookshelf"
required: true
schema:
$ref: "#/definitions/Book"
responses:
400:
description: "Invalid ID supplied"
404:
description: "Book not found"
405:
description: "Validation exception"
security:
- bookshelf_auth:
- "write:books"
- "read:books"
x-swagger-router-controller: "Book"
/book/{bookId}:
get:
tags:
- "book"
summary: "Find book by ID"
description: "Returns a single book"
operationId: "getBookById"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "bookId"
in: "path"
description: "ID of book to return"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Book"
400:
description: "Invalid ID supplied"
404:
description: "Book not found"
security:
- api_key: []
x-swagger-router-controller: "Book"
post:
tags:
- "book"
summary: "Updates a book in the bookshelf with form data"
description: ""
operationId: "updateBookWithForm"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "bookId"
in: "path"
description: "ID of book that needs to be updated"
required: true
type: "integer"
format: "int64"
- name: "name"
in: "formData"
description: "Updated name of the book"
required: false
type: "string"
- name: "status"
in: "formData"
description: "Updated status of the book"
required: false
type: "string"
responses:
405:
description: "Invalid input"
security:
- bookshelf_auth:
- "write:books"
- "read:books"
x-swagger-router-controller: "Book"
delete:
tags:
- "book"
summary: "Deletes a book"
description: ""
operationId: "deleteBook"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "api_key"
in: "header"
required: false
type: "string"
- name: "bookId"
in: "path"
description: "Book id to delete"
required: true
type: "integer"
format: "int64"
responses:
400:
description: "Invalid ID supplied"
404:
description: "Book not found"
security:
- bookshelf_auth:
- "write:books"
- "read:books"
x-swagger-router-controller: "Book"
/user:
post:
tags:
- "user"
summary: "Create user"
description: "This can only be done by the logged in user."
operationId: "createUser"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Created user object"
required: true
schema:
$ref: "#/definitions/User"
responses:
default:
description: "successful operation"
x-swagger-router-controller: "User"
/user/login:
get:
tags:
- "user"
summary: "Logs user into the system"
description: ""
operationId: "loginUser"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "query"
description: "The user name for login"
required: true
type: "string"
- name: "password"
in: "query"
description: "The password for login in clear text"
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "string"
headers:
X-Rate-Limit:
type: "integer"
format: "int32"
description: "calls per hour allowed by the user"
X-Expires-After:
type: "string"
format: "date-time"
description: "date in UTC when token expires"
400:
description: "Invalid username/password supplied"
x-swagger-router-controller: "User"
/user/logout:
get:
tags:
- "user"
summary: "Logs out current logged in user session"
description: ""
operationId: "logoutUser"
produces:
- "application/xml"
- "application/json"
parameters: []
responses:
default:
description: "successful operation"
x-swagger-router-controller: "User"
/user/{username}:
get:
tags:
- "user"
summary: "Get user by user name"
description: ""
operationId: "getUserByName"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "path"
description: "The name that needs to be fetched. Use user1 for testing. "
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
400:
description: "Invalid username supplied"
404:
description: "User not found"
x-swagger-router-controller: "User"
put:
tags:
- "user"
summary: "Updated user"
description: "This can only be done by the logged in user."
operationId: "updateUser"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "path"
description: "name that need to be updated"
required: true
type: "string"
- in: "body"
name: "body"
description: "Updated user object"
required: true
schema:
$ref: "#/definitions/User"
responses:
400:
description: "Invalid user supplied"
404:
description: "User not found"
x-swagger-router-controller: "User"
delete:
tags:
- "user"
summary: "Delete user"
description: "This can only be done by the logged in user."
operationId: "deleteUser"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "path"
description: "The name that needs to be deleted"
required: true
type: "string"
responses:
400:
description: "Invalid username supplied"
404:
description: "User not found"
x-swagger-router-controller: "User"
securityDefinitions:
bookshelf_auth:
type: "oauth2"
authorizationUrl: "http://www.example.com/oauth/dialog"
flow: "implicit"
scopes:
write:books: "modify books in your account"
read:books: "read your books"
api_key:
type: "apiKey"
name: "api_key"
in: "header"
definitions:
User:
type: "object"
properties:
id:
type: "integer"
format: "int64"
username:
type: "string"
firstName:
type: "string"
lastName:
type: "string"
email:
type: "string"
password:
type: "string"
phone:
type: "string"
userStatus:
type: "integer"
format: "int32"
description: "User Status"
example:
firstName: "firstName"
lastName: "lastName"
password: "password"
userStatus: 6
phone: "phone"
id: 0
email: "email"
username: "username"
xml:
name: "User"
Book:
type: "object"
required:
- "name"
properties:
id:
type: "integer"
format: "int64"
name:
type: "string"
example: "doggie"
status:
type: "string"
description: "book status in the bookshelf"
enum:
- "available"
- "pending"
- "sold"
example:
name: "doggie"
id: 0
status: "available"
xml:
name: "Book"
externalDocs:
description: "Swaggerについて詳細はコチラ"
url: "http://swagger.io"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment