Add GitHub API example

Author: camilamaia

github-api/README.md

@@ -0,0 +1,18 @@
+# GitHub REST API
+
+You can use the [GitHub REST API](https://docs.github.com/en/rest) to create calls to get the data you need to integrate with [GitHub](http://github.com/).
+
+## Run
+
+Requirements:
+- [ScanAPI](https://pypi.org/project/scanapi/)
+- [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
+
+```shell
+$ git clone [email protected]:scanapi/examples.git
+$ cd github-api
+$ export GITHUB_API_TOKEN=<your_github_personal_access_token>
+$ scanapi run scanapi.yaml
+```
+
+The report will be available at `scanapi-report.html`

github-api/gists.yaml

@@ -0,0 +1,49 @@
+- name: gists
+  path: gists
+  headers:
+    Authorization: token ${GITHUB_API_TOKEN}
+    Accept: application/vnd.github.v3+json
+  requests:
+    - name: list all public gists
+      tests:
+        - name: status_code_is_200
+          assert: ${{ response.status_code == 200 }}
+    - name: create a gist
+      method: post
+      body:
+        files:
+          my_gist:
+            content: "Hello, that is my gist. I'm a super gist! "
+        description: hello!!
+        public: true
+      vars:
+        gist_id: ${{ response.json()["id"] }}
+      tests:
+        - name: status_code_is_201
+          assert: ${{ response.status_code == 201 }}
+  endpoints:
+    - name: details
+      path: ${gist_id}
+      requests:
+        - name: gist details
+          tests:
+            - name: status_code_is_200
+              assert: ${{ response.status_code == 200 }}
+            - name: id matches
+              assert: ${{ response.json()["id"] == "${gist_id}" }}
+        - name: update gist
+          method: patch
+          body:
+            files:
+              my_gist:
+                content: "Hello, that is my gist. I'm a super gist! "
+            description: Hello super updated! Yay!
+            public: true
+          tests:
+            - name: status_code_is_200
+              assert: ${{ response.status_code == 200 }}
+        - name: delete gist
+          method: delete
+          tests:
+            - name: status_code_is_204
+              assert: ${{ response.status_code == 204 }}