Playground

First Encounter

When you first enter the playground, you will see 3 part :

PlayGround

Part One : Tabs

At the top of the page there are tabs that allow you to do different things at the same time without losing information. You can make and use as many tabs you need(2) with add button(1) and close them at any time with close button(3). By refreshing the page, the tabs information does not disappear and after the tab refresh the tabs are fully accessible.

Tabs

Part Two: Sidebar

On the left side is the sidebar, with 3 select box that are used to select the service(1), Schema(2) and Action(3), respectively. It should be noted that the selection of Schema and act is inactive until the service is selected.

Sidebar

Second Sidebar

After selecting the service, Schema and act, another column is displayed, which includes 2 sections of set fields(1) and get fields(2). In the set fields, you fill in the values you need(1-1) and in the get field section you choose the values you want to get and also we either want the field to set the field equal to one or we do not want the amount to be zero(2-1). After completing the sections of the set fields and get fields set, by pressing the Send Button(3), the results we have had in the response section are shown in the response section.

Second Sidebar

Response

Response Section

At the top of the response section, we have access to 3 button, copy Request(1), copy Response(2) and Run E2E Test(3) that send the request to the E2E Test modal that we will explain below.

Also we can see the status of the request who can be true with green light and false with red loght(4).

At the top-right of the body response we can access to the time of the request with took(5).

Response-Detail

Part Three: Buttons

In this section we will see 6 buttons that we will explain below :

Buttons

Before explain 6 buttons, Notice that in every modal we can use the close button(1) to close the modal. Modals

Also we can use change size button(2) to see modal in full screen or window size. Modals-1

Modals-2

Refetch button:

Pressing it all the data is renewed once.

Reffetch Button

Settings button:

Setting Button

Pressing that modal of settings open for us to see two parts of the Fetch Config(1) and the Set Headers(2).

Setting Detail

In the fetch config section, we can set an Url(1) and press Apply Button(2) that we can bring the lesan to different addresses.

Setting Detail-1

In the set headers we can also determine the key(1) and value(2). also we can press Add Header(3) button to add many new Key and Value and set them wit Apply(4) button.

Setting Detail-2

History button:

By pressing History button, we enter the modal history in which we have access to all the Requests(1) as well as and Responses(2) the results.

In top-right of the Request section we can see the Date Of The Request and also in top-left of the Response we can see the Time Of Response.

In top-right of the every part of the request we can delete the this part with Delete button(5).

Also we can clean all the request by press the Dustbin Button(6).

History

In the request section we access to Model and Act(1) of the request and Show Button(2) to see the detail of the request and response.

History-1

We can hide the details with Hide button: History-2

In the response section, we can see the Status Of The Response(1) that can be true or false and also we can reuse of the request with Use Button(2).

History-3

E2E Test button:

In E2E test modal, we see two section, section one include Five Button that the top-left of the modal and section two its be Eeach Sequence of the test.

E2E

We start with the section one, in this section we have five button include Add(1), Run E2E Test(2), Import(3), Export(4) and Help(5).

E2E-1

With Add Button we can create a new Sequence for test. we can add how much we need sequence for test.

E2E-2

With Run E2E Test Button we can run the test. we explain this after.

With Import Button we can import the pervious tests and reuse them.

E2E-3

With Export Button we can export existing tests for use them for anothe test.

And with Help Button we go to playground document that we can see how to work with E2E modal.


In each sequence, we can see 2 part, Set Test Body And Headers(1) and Set Repeat Time, Capture Variables(2) E2E-4

Part 1 is a Set Test Body And Headers that we can write and set body and headers for test. also we can use the faker for test. for example you can see that we use faker for this sequense: E2E-4

In Part two we can Set Repeat Time(1) of the test with + or - button or write number we want in input. also we can use Add Capture(2) Button for set how many capture we want to the sequence for test. E2E-5

After press the Add Capture we can see a part that include two input, include set a variable name(1) that we can see an Example(2) to how fill this input and another input, is set a value for variable(3) that we can see an Example(4) to how fill this input. Also we can set capture couple model. E2E-6

We have four button in top-right of the each sequence test: E2E-7

Duplicate Button(1) that we can duplicate sequence. E2E-8

Move Buttuns(2)(3), with this buttons we can move the sequense to top or bottom.

Delete Button(4), with this button we can delete each sequence.


After write the sequences test, we can go to see the resulst of the each sequence test by click on the Run E2E Test Button and we see this:
E2E-9

First thing that we see is Back Button and second is Export Button at the top-left of the modal.

third one is a Information section that we can see all information of the sequence tests.

E2E-10

The Information section have three part, Requests(1),Times(2) and Captures Information(3).

E2E-11

Requests part include All Request Count(1) , All Request Time(2), All Success Request(3) and All Fails Request(4). E2E-12

Times part include two section, Best and Worst. in each section we can see the Best/Worst request time, sequence number of the best/worst request that when click on number, we scroll to that sequence number, request number that include number of the request in sequence, model and act.

E2E-13

Captures Information part include every capture items that we set. in this part we can see the Key(1), Captured From(2), Value Of(2), Model(2), Act(2) and Captured Inside Sequnce Number.

E2E-14

After Information section, we can access every sequence that each of sequence have two part, Description(1) and Body Header(2).

E2E-15

Description have five part include Request(1) that include All Request Count, Success/Fail that show the how many of request is success/Fail, All Request Time and Avrage Time For Each Request, Best(2) and Worst(3) that include Best/Worst Time and request nmber, Capture Items(4) that include key,value,model,act,sequence number, Using Capture Items(5) that include key,captured from, value,act and sequence number.

E2E-16

Body Header have headers,body of the each sequence(1), number of sequence(2) at the top-right and change button(3) at the top-left.

E2E-17

When click on Change Button we can see and access to the Request(1) and Response(2) that in Request section we can see the pure request(3) and at the Response section we can see the body of the response and success status of Responsewhich the false or true(4).

At the top-right of the Response section we can see the time of the Respone(5).

At the Bottom-center, we can access to the pagination(6) to move on the Requests or write the specefic Request number to access the Request.

Also when click on change button(7) to go back to the Body Header and Description.

E2E-18

Schema button:

In Schema modal we have access to all the Schema project. For example, we can see the country,city and user. Schema

Country have pure(1) and related relations(2). Schema-1

And pure have _id(1), name(2), population(3), abb(4). Schema-2

And Also related relations have cities asc(1), cities desc(2), cities by pop asc(3), cities by pop desc(4), capital city(5), users(6), users by age(7). Schema-3

Also by hovering on question icon we can see the relations. Schema-4

We see the country, lets see the city. city have pure(1), main Relation(2), related relations(3). Schema-5

Pure have _id(1), name(2), population(3), abb(4). Schema-6

main relations have country and country have _id, name, population and abb. Schema-7

Also by hovering on question icon we can see the relations. Schema-8

And related relations have users(1) and loved user(2). Schema-9

Users have _id, name, age. Schema-10

Act button:

Like Schema modal in Act modal , we have access to all the Act of the project. Act have main and main have country(1), city(2), user(3). Act-1

And country have add country(1), update country(2), add countries(3), get countries(4), delete country(5). Act-2

Let see the add country. we can see the set(1) and get(2). Act-3

Set have name(1), population(2) and abb(3). Act-4

And get have _id(1), name(2), population(3), abb(4), users(5). Act-4