kpbrandt.com API

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/docsschema.js"></script>

# Install the Python client library
$ pip install coreapi

bart

list

GET /api/bart

Query BART API for delays in service

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action bart list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["bart", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["bart", "list"]
result = client.action(schema, action)

bs

list

GET /api/bs

Generate some corporate bs

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action bs list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["bs", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["bs", "list"]
result = client.action(schema, action)

confucius

list

GET /api/confucius

Random Confucius quote

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action confucius list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["confucius", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["confucius", "list"]
result = client.action(schema, action)

quotes

list

GET /api/quotes

Return all quotes, paginated

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action quotes list -p page=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["quotes", "list"]
var params = {
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["quotes", "list"]
params = {
    "page": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/quotes

Create a new quote.

Request Body

The request body should be a "application/x-www-form-urlencoded" encoded object, containing the following items.

Parameter	Description
`phrase` required
`author` required

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action quotes create -p phrase=... -p author=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["quotes", "create"]
var params = {
    phrase: ...,
    author: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["quotes", "create"]
params = {
    "phrase": ...,
    "author": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/quotes/{id}

Returns a specific quote.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this quotes.

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action quotes read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["quotes", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["quotes", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/quotes/{id}

Updates a specific quote.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this quotes.

Request Body

The request body should be a "application/x-www-form-urlencoded" encoded object, containing the following items.

Parameter	Description
`phrase` required
`author` required

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action quotes update -p id=... -p phrase=... -p author=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["quotes", "update"]
var params = {
    id: ...,
    phrase: ...,
    author: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["quotes", "update"]
params = {
    "id": ...,
    "phrase": ...,
    "author": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/quotes/{id}

Delete a quote.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this quotes.

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action quotes delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["quotes", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["quotes", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

random > list

GET /api/quotes/random

Grab a random quote.

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action quotes random &gt; list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["quotes", "random &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["quotes", "random &gt; list"]
result = client.action(schema, action)

reversed

list

GET /api/reversed

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`string` required

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action reversed list -p string=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["reversed", "list"]
var params = {
    string: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["reversed", "list"]
params = {
    "string": ...,
}
result = client.action(schema, action, params=params)

weather

list

GET /api/weather

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`city` required
`state` required

# Load the schema document
$ coreapi get https://kpbrandt.com/docs

# Interact with the API endpoint
$ coreapi action weather list -p city=... -p state=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["weather", "list"]
var params = {
    city: ...,
    state: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://kpbrandt.com/docs")

# Interact with the API endpoint
action = ["weather", "list"]
params = {
    "city": ...,
    "state": ...,
}
result = client.action(schema, action, params=params)