Add scanapi-demo example

camilamaia · camilamaia · commit fceb72af67f9 · 2020-05-24T08:25:12.000-03:00
diff --git a/scanapi-demo/.env b/scanapi-demo/.env
@@ -0,0 +1,2 @@
+export BASE_URL="http://demo.scanapi.dev/api/"
+export DEMO_KEY="demoKEY123"
diff --git a/scanapi-demo/.scanapi.yaml b/scanapi-demo/.scanapi.yaml
@@ -0,0 +1,4 @@
+report:
+  hide-request:
+    headers:
+      - x-api-key
diff --git a/scanapi-demo/api.yaml b/scanapi-demo/api.yaml
@@ -0,0 +1,55 @@
+api:
+  endpoints:
+    - name: scanapi-demo
+      path: ${BASE_URL}
+      requests:
+        - name: health
+          method: get
+          path: /health/
+        - name: languages
+          method: get
+          path: /languages/
+      endpoints:
+        - name: devs
+          path: /devs/
+          requests:
+            - name: list_all
+              method: get
+              vars:
+                uuid: ${{response.json()[2]["uuid"]}}
+            - name: looking_for_new_opportunities
+              method: get
+              params:
+                newOpportunities: true
+            - name: not_looking_for_new_opportunities
+              method: get
+              params:
+                newOpportunities: false
+            - name: new
+              method: post
+              headers:
+                x-api-key: ${DEMO_KEY}
+              body:
+                uuid: ${{uuid.uuid4().hex}}
+                name: Tarik
+                yearsOfExperience: 2
+                languages:
+                  - ruby
+                    go
+                newOpportunities: false
+            - name: details_not_found
+              path: 129e8cb2-d19c-51ad-9921-cea329bed7fa
+              method: get
+          endpoints:
+            - name: details
+              path: ${uuid}
+              requests:
+                - name: get
+                  method: get
+                - name: delete
+                  method: delete
+                  headers:
+                    x-api-key: ${DEMO_KEY}
+                - name: languages
+                  path: languages
+                  method: get
diff --git a/scanapi-demo/scanapi-report.html b/scanapi-demo/scanapi-report.html
@@ -0,0 +1,55 @@
+<!doctype html>
+
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+
+  <title>ScanAPI Report</title>
+  <meta name="description" content="ScanAPI Report">
+  <meta name="author" content="camilamaia/scanapi">
+</head>
+
+<body>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/health/</h2>
+        <p>200</p>
+    </div>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/languages/</h2>
+        <p>200</p>
+    </div>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/devs/</h2>
+        <p>200</p>
+    </div>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/devs/?newOpportunities=True</h2>
+        <p>200</p>
+    </div>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/devs/?newOpportunities=False</h2>
+        <p>200</p>
+    </div>
+  <div>
+        <h2>POST http://demo.scanapi.dev/api/devs/</h2>
+        <p>201</p>
+    </div>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-51ad-9921-cea329bed7fa</h2>
+        <p>404</p>
+    </div>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0</h2>
+        <p>200</p>
+    </div>
+  <div>
+        <h2>DELETE http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0</h2>
+        <p>200</p>
+    </div>
+  <div>
+        <h2>GET http://demo.scanapi.dev/api/devs/129e8cb2-d19c-41ad-9921-cea329bed7f0/languages</h2>
+        <p>200</p>
+    </div>
+  
+</body>
+</html>
diff --git a/scanapi-demo/scanapi-report.md b/scanapi-demo/scanapi-report.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export BASE_URL="http://demo.scanapi.dev/api/"`
	`2`	`+export DEMO_KEY="demoKEY123"`