Add *very* basic Swagger API definition

2016-10-27 20:11:22 +02:00
parent 6a9bddadde
commit 07872f8e24
1 changed files with 21 additions and 0 deletions
--- a/swagger/swagger.yaml
+++ b/swagger/swagger.yaml
@@ -0,0 +1,21 @@
+swagger: "2.0"
+info:
+  version: "0.0.0"
+  title: "Rubber Duck Booking Tool API"
+basePath: /api/v1
+consumes:
+  - application/json
+produces:
+  - application/json
+securityDefinitions:
+  api_key:
+    type: apiKey
+    name: token
+    in: header
+paths:
+  /ducks/:
+    get:
+      description: "Get the list of all ducks"
+      responses:
+        "200":
+          description: "An object which contains metadata and an array of ducks"