Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: Inventory API
version: v2
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
documentation:
- title: "ISBN API"
content: <b>API for validation and conversion of ISBN-10 and ISBN-13 numbers </b>
types:
isbn:
type: object
properties:
isbn: string
additionalProperties: false
isValid:
type: object
properties:
isValid: boolean
additionalProperties: false
/isbn:
/convertTo13:
get:
description: Converts an ISBN code to an ISBN-13 code
queryParameters:
isbn:
displayName: Isbn
type: string
example: "091698477X"
required: true
hyphens:
displayName: Hyphens
type: boolean
default: false
required: false
responses:
200:
description: "The response body is a json object containing the converted isbn"
body:
application/json:
type: isbn
example: !include examples/isbn13.json
400:
description: "Bad request, an invalid ISBNs is provided"
body:
text/plain:
example: "ISBN value is invalid"
/convertTo10:
get:
description: "Converts an ISBN-13 code to an ISBN-10 code"
queryParameters:
isbn:
displayName: ISBN
type: string
example: "978-1-930110-99-1"
required: true
hyphens:
displayName: Hyphens
type: boolean
default: false
required: false
responses:
200:
description: "The response body is a json object containing the converted isbn"
body:
application/json:
type: isbn
example: !include examples/isbn10.json
400:
description: "Bad request, an invalid ISBNs is provided"
body:
text/plain:
example: "ISBN value is invalid"
/validator:
get:
description: Checks the code is a valid ISBN code.
queryParameters:
/^(isbn|isbn10|isbn13)$/: string
responses:
200:
description: "Returns true if a valid ISBN code, otherwise false"
body:
application/json:
type: isValid
example: !include examples/isbn_validation_result.json
400:
description: "Bad request, invalid query parameter is provided"
body:
text/plain:
example: "Only one of following query params must be specified: isbn, isbn10, isbn13"