zdne

My API

Lorem Ipsum

Group My Stuff

My Message [/message]

• Response 200 (text/plain)

    Hello World!
  

zdne

Modeling API

Question: Affordances or web link relations for modeling your API?

I have been pondering this question a lot lately. Given a resource and its attributes (semantic descriptors), would you model the API using the link / relations or resource affordances? May one relation as defined by RFC5988 Web Linking imply multiple affordances? For example does the edit relation represents three affordances (retrieve, update, and delete)?

Is (should?) the perspective affordances vs. relations differ based on the point of view (API design, client, server).

Most of the hypermedia media types such as HAL, Collection+JSON and JSON API are built around link relations. Seems that on

zdne

express = require 'express'
app = express()

PORT = 1234

app.get '/machines', (req, res) ->
  res.setHeader 'Content-Type', 'application/json'
  machine =
    type: 'bulldozer'
    name: 'willy'

zdne

#include <string>
#include <vector>
#include <regex>

enum MarkdownNodeType {
    RootMarkdownNodeType = 0,
    HeaderMarkdownNodeType,
    ListItemMarkdownNodeType,
    ParagraphMarkdownNodeType,
    UndefinedMarkdownNodeType = -1

zdne

HAL Object

• _links - Links (to URIs)

  • {relation name}

    A resource may have multiple links that share the same link relation. For link relations that may have multiple links, we use an array of links.

    • One of
      • (Relation)
      • (array: Relation)

zdne

FORMAT: 1A

# Gist Fox API
Gist Fox API is a **pastes service** similar to [GitHub's Gist](http://gist.github.com).

## Authentication
*Gist Fox API* uses OAuth Authorization. First you create a new (or acquire existing) OAuth token using Basic Authentication. After you have acquired your token you can use it to access other resources within token' scope.

## Media Types
Where applicable this API uses the [HAL+JSON](https://github.com/mikekelly/hal_specification/blob/master/hal_specification.md) media-type to represent resources states and affordances.

zdne

$KEY: $VALUE

$API_NAME

$DESCRIPTION

group $GROUP_NAME

$DESCRIPTION

$RESOURCE_NAME [$URI_TEMPLATE]

$DESCRIPTION

zdne

#!/bin/bash

echo -n "GitHub User: "
read USER

echo -n "GitHub Password: "
read -s PASS

echo ""
echo -n "GitHub Repo (e.g. foo/bar): "

zdne

# Data Document

This document contains a description of a data.

# Data Structures

## Some Data (object)

- name: Z (string) - Good old name.

zdne

Format: 1A Host: http://blog.acme.com

Basic ACME Blog API

NOTE: This document is outdated. Refer to the actual API Blueprint examples.

Welcome to the ACME Blog API. This API provides access to the ACME Blog service.