Permalink
Browse files

Transferring blueprint from apiary.io

  • Loading branch information...
1 parent 23b9a5b commit 0e47ad51e3ef8058e9bb59460c804b60d1a5ca23 @abtris committed Dec 29, 2012
Showing with 56 additions and 0 deletions.
  1. +56 −0 apiary.apib
View
@@ -0,0 +1,56 @@
+HOST: http://screencast.dev/
+
+--- Screencast apiary demo ---
+---
+Welcome to the our sample API documentation. All comments can be written in (support [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax)
+---
+--
+Items
+--
+List items
+GET /items
+< 200
+< Content-Type: application/json
+{ "items": [
+ { "id":1 ,"name": "Item 1", "description": "Lorem ipsum ..." },
+ { "id":2 ,"name": "Item 2", "description": "Lorem Ipsum ..." }
+] }
+
+Get Item
+GET /item/1
+< 200
+< Content-Type: application/json
+{
+ "id": 1, "name": "Item 1", "description": "Lorem ipsum ..."
+}
+
+GET /item/2
+< 200
+< Content-Type: application/json
+{
+ "id": 2, "name": "Item 2", "description": "Lorem ipsum ..."
+}
+
+
+Save item
+POST /item
+> Content-Type: application/json
+{ "name":"Item 3", "description": "Lorem ipsum ..." }
+< 201
+< Content-Type: application/json
+{ "status": "created", "id": 3 }
+
+Update item
+PUT /item/1
+> Content-Type: application/json
+{ "name": "Item updated 1", "description": "Ipsum ..."}
+< 200
+< Content-Type: application/json
+{ "status": "updated" }
+
+Remove item
+DELETE /item/1
+> Content-Type: application/json
+< 200
+< Content-Type: application/json
+{ "status": "removed" }

0 comments on commit 0e47ad5

Please sign in to comment.