Merge pull request #10 from jfollmann/master

feat: Added jsonplaceholder example

Author: camilamaia

jsonplaceholder-api/.env

@@ -0,0 +1 @@
+export BASE_URL=https://jsonplaceholder.typicode.com

jsonplaceholder-api/README.md

@@ -0,0 +1,17 @@
+# Jsonplaceholder REST API
+
+[jsonplaceholder.typicode.com](https://jsonplaceholder.typicode.com) is a fake online REST API for testing and prototyping.
+
+## Run
+
+Requirements:
+- [ScanAPI](https://pypi.org/project/scanapi/)
+
+```shell
+$ git clone [email protected]:scanapi/examples.git
+$ cd jsonplaceholder-api
+$ source .env
+$ scanapi run main.yaml
+```
+
+The report will be available at `scanapi-report.html`

jsonplaceholder-api/main.yaml

@@ -0,0 +1,28 @@
+endpoints:
+  - name: Jsonplaceholder API Tests
+    path: ${BASE_URL}
+    endpoints:
+      - name: user_actions
+        path: users
+        requests: !include resources/users.yaml
+        endpoints:      
+          - name: user_todos
+            path: ${userId}/todos
+            requests: !include resources/todos.yaml
+
+          - name: user_album
+            path: ${userId}/albums
+            requests: !include resources/albums.yaml
+
+          - name: user_posts
+            path: ${userId}/posts
+            requests: !include resources/user_posts.yaml
+
+      - name: post_actions
+        path: posts
+        requests:
+          !include resources/posts.yaml
+        endpoints:
+          - name: comments_by_post
+            path: ${postId}/comments
+            requests: !include resources/comments.yaml

jsonplaceholder-api/resources/albums.yaml

@@ -0,0 +1,11 @@
+- name: get_all
+  method: get
+  vars:
+    recordId: ${{ response.json()[0]["id"] }}
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+      
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}

jsonplaceholder-api/resources/comments.yaml

@@ -0,0 +1,11 @@
+- name: get_all
+  method: get
+  vars:
+    recordId: ${{ response.json()[0]["id"] }}
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+      
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}

jsonplaceholder-api/resources/posts.yaml

@@ -0,0 +1,86 @@
+- name: get_all
+  method: get
+  vars:
+    postId: ${{ response.json()[0]["id"] }}
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: get_by_id
+  path: ${postId}
+  method: get
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: get_with_filter
+  params:
+    userId: 1
+  method: get
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: create_new
+  method: post
+  vars:
+    newRecordId: ${{ response.json()["id"] }}
+  body:
+    title: Post Title
+    body: Post Body
+    userId: 1
+  tests:
+    - name: status_code_is_201
+      assert: ${{ response.status_code == 201 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: update_with_put
+  method: put
+  path: ${newRecordId}
+  body:
+    id: ${newRecordId}
+    title: Post Title - Update with PUT
+    body: Post Body - Update with PUT
+    userId: 1
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: update_with_path
+  method: patch
+  path: ${newRecordId}
+  body:
+    title: Post Title - Update with Patch
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: delete
+  method: delete
+  path: ${newRecordId}
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}

jsonplaceholder-api/resources/todos.yaml

@@ -0,0 +1,11 @@
+- name: get_all
+  method: get
+  vars:
+    recordId: ${{ response.json()[0]["id"] }}
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}

jsonplaceholder-api/resources/user_posts.yaml

@@ -0,0 +1,11 @@
+- name: get_all
+  method: get
+  vars:
+    recordId: ${{ response.json()[0]["id"] }}
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}

jsonplaceholder-api/resources/users.yaml

@@ -0,0 +1,101 @@
+- name: get_all
+  method: get
+  vars:
+    userId: ${{ response.json()[0]["id"] }}
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: get_by_id
+  path: ${userId}
+  method: get
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: get_with_filter
+  params:
+    userId: 1
+  method: get
+  body:
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: create_new
+  method: post
+  vars:
+    newRecordId: ${{ response.json()["id"] }}
+  body:
+    name: User Test
+    username: user_test
+    email: [email protected]
+    address:
+      street: Victor Plains
+      suite: Suite 879
+      city: Wisokyburgh
+      zipcode: 90566-7771
+      geo:
+        lat: -43.9509
+        lng: -34.4618
+  tests:
+    - name: status_code_is_201
+      assert: ${{ response.status_code == 201 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: update_with_put
+  method: put
+  path: ${newRecordId}
+  body:
+    name: User Test - PUT
+    username: user_test_put
+    email: [email protected]
+    address:
+      street: Victor Plains PUT
+      suite: Suite 879 PUT
+      city: Wisokyburgh PUT
+      zipcode: 90566-7771
+      geo:
+        lat: -43.9509
+        lng: -34.4618
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: update_with_path
+  method: patch
+  path: ${newRecordId}
+  body:
+    name: User Test - Patch
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}
+
+- name: delete
+  method: delete
+  path: ${newRecordId}
+  tests:
+    - name: status_code_is_200
+      assert: ${{ response.status_code == 200 }}
+    
+    - name: response_time_is_under_a_second
+      assert: ${{ response.elapsed.total_seconds() < 1 }}