Back to top

Fake Better API

This is a basic example API for our talk at http://betterapis.com.

Resource Group

Foo

listFoo
GET/foo{?limit}

Example URI

GET http://api.betterapis.com//foo?limit=
URI Parameters
HideShow
limit
string (optional) Default: 10 

maximum number of foo to return

Response  200
HideShow
Headers
Content-Type: application/json
Body
List all foo

+ Attributes (array[Foo])

Foo

putFoo
PUT/foo

Example URI

PUT http://api.betterapis.com//foo
Request
HideShow
Headers
Content-Type: application/json
Body
{}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {}
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
Updates a foo

+ Attributes (Dynamic)
Response  400
HideShow
Body
Invalid foo data

postFoo
POST/foo

Example URI

POST http://api.betterapis.com//foo
Request
HideShow
Headers
Content-Type: application/json
Body
{}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {}
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
Creates a foo

+ Attributes (Dynamic)
Response  400
HideShow
Body
Invalid foo data

Foo By FooId

getFooByID
GET/foo/{fooId}

Example URI

GET http://api.betterapis.com//foo/fooId
URI Parameters
HideShow
fooId
string (required) 

ID of the foo

Response  200
HideShow
Headers
Content-Type: application/json
Body
Foo with the specified ID

+ Attributes (Dynamic)
Response  404
HideShow
Body
Foo with specified ID not found

Generated by aglio on 18 Jul 2016