Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding UI for API editor #8

Open
goldbergyoni opened this issue Oct 26, 2018 · 2 comments
Open

Adding UI for API editor #8

goldbergyoni opened this issue Oct 26, 2018 · 2 comments
Assignees

Comments

@goldbergyoni
Copy link
Owner

goldbergyoni commented Oct 26, 2018

@TITAN9389 So we wanna to allow the users to test their API as the monkey is doing pranks within the process.

Requirements:

  • Menu" should include 2 links: Define API & Chaos Test
  • Define API view: should include UI to define REST API routes like POSTMAN and even allow importing Swagger. Better if we can find a component that implements this. Anyway, for the first revision, we only need to gather the URL field because the 1st version can only perform GET requests
  • Chaos test view: this view allows running tests against the API that we defined in the previous view. The view constitutes 3 parts:

The Chaos Test View Panels

A - Choose Chaos: a center top panel that shows the pranks plan and list with Start and Stop buttons. Once we click Start the panel hides (Except for the button Stop). Once we click Stop the panel is shown again.

Once the user clicks start we start approaching the GET URL constantly and store the number of requests, num of errros, average latency (how much time all the requests took / number of requests), and if the API is not answering for 10 seconds we set the variable

B - Chaos metrics: a center panel that shows 4 badges/metrics ->

  1. Num Of Requests (number of requests)
  2. Errors (number of errors)
  3. Avg Latency
  4. Is alive

Each metric is a Bootstrap badge <span class="badge"> with some adequate glyphicon

C - Pranks log: Center bottom panel that shows the pranks list like we have today

Focus:

Let's start with a minimal version, share a quick version (hopefully today/Saturday early) and then add the rest. A minimal version can include: (a) API definition with url field only (b) choose chaos without stop button (c) only number of requests metric. This way we can discuss over the minimal version, and add the missing parts by Saturday evening (preferable!) or Sunday morning.

Thoughts?

@sebmaz93
Copy link
Collaborator

ok i got it all @i0natan , could't find any React integration for that API stuff will try to look again.

@goldbergyoni
Copy link
Owner Author

@TITAN9389

I suggest leaving this for today and focus on the minimal version first. Then, if we have time tomorrow let's enhance. Cool?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants