A collection of code snippets for the "Words Of Wisdom" API.

swagger.json

{
    "swagger": "2.0",
    "info": {
        "version": "0.0.1",
        "title": "Words Of Wisdom",
        "description": "An API for recording and reflecting quotes.",
        "contact": {
            "name": "Corey Stubbs",
            "email": "cstubbs@us.ibm.com",
            "url": "https://github.com/Lull3rSkat3r"
        }
    },
    "paths": {
        "/random": {
            "get": {
                "description": "Returns a random quote",
                "responses": {
                    "200": {
                        "description": "A string containing the quote",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/quote": {
            "post": {
                "description": "Adds a quote",
                "parameters": [
                    {
                        "name": "body",
                        "in": "body",
                        "description": "The quote to be added to the collection",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Returns the id of the newly create quote, which can be used to access the quote",
                        "schema": {
                            "type": "integer"
                        }
                    }
                }
            }
        },
        "/quote/{id}": {
            "get": {
                "description": "Gets the quote",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "The quote to be added to the collection",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Returns the id of the quote, which can be used to access the quote",
                        "schema": {
                            "type": "integer"
                        }
                    }
                }
            },
            "put": {
                "description": "Updates the content of quote.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "The quote to be added to the collection",
                        "required": true,
                        "type": "string"
                    },
                    {
                        "name": "body",
                        "in": "body",
                        "description": "The new value of the quote",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "204": {
                        "description": "The quote has successfully been updated."
                    }
                }
            }
        }
    }
}

swagger.yaml

swagger: '2.0'
info:
  version: 0.0.1
  title: 'Words Of Wisdom'
  description: An API for recording and reflecting quotes.
  contact:
    name: Corey Stubbs
    email: cstubbs@us.ibm.com
    url: 'https://github.com/Lull3rSkat3r'
paths:
  /random:
    get:
      description: Returns a random quote
      responses:
        '200':
          description: A string containing the quote
          schema:
            type: string
  /quote:
    post:
      description: Adds a quote
      parameters:
        - name: body
          in: body
          description: The quote to be added to the collection
          required: true
          schema: 
            type: string
      responses:
        '201':
          description: Returns the id of the newly create quote, which can be used to access the quote
          schema: 
            type: integer
  /quote/{id}:
    get:
      description: Gets the quote
      parameters:
        - name: id
          in: path
          description: The quote to be added to the collection
          required: true
          type: string
      responses:
        '201':
          description: Returns the id of the quote, which can be used to access the quote
          schema: 
            type: integer
    put:
      description: Updates the content of quote.
      parameters:
        - name: id
          in: path
          description: The quote to be added to the collection
          required: true
          type: string
        - name: body
          in: body
          description: The new value of the quote
          required: true
          schema: 
            type: string
      responses:
        '204':
          description: The quote has successfully been updated.

WordsOfWisdomApi-Empty.ipynb

WordsOfWisdomApi-Implemented.ipynb