Quick Start

Sign Up

You'll need to sign up to OnlineOrNot if you haven't already: OnlineOrNot Sign Up Page

Add an Application

Once you've created an account and logged in for the first time, you're ready to add your first application - either click on "Applications" in the Main Menu, or click here.

You should see the form below: OnlineOrNot Create Application Give your application a name, and enter the URL that your GraphQL server is running on (typically https://yourappdomain.com/graphql)

Create a Test

Once you've added a GraphQL server, you're ready to start testing it. Either click on "Tests" in the Main Menu or click here. OnlineOrNot Main Menu

You should see the form below: OnlineOrNot Create Test To get started quickly, the only required fields to enter are the Application, Query and Expected Result.

If you are unsure of the Expected Result, clicking the "Test" button near the bottom of the form will send a GraphQL request to your server and populate the "Expected Result" field.

OnlineOrNot Test Expected Result

Headers

Should your GraphQL server require advanced configuration such as custom headers, you can enter them in the "Headers" tab.

Secret Headers

We also support secrets in the header fields - if you have any sensitive values, you can add them via the "Secret Headers" form in the "Headers" tab.

Secret Headers are not visible to anyone (including you and your team mates) once you save the form (inspecting the form will just give you a Buffer array of encrypted data).

Viewing Results

Once you've set up your test, in the Tests page you'll be able to see a list your tests, and view their results: OnlineOrNot Tests View When you click Results, you should see that OnlineOrNot is getting ready to run your first test: OnlineOrNot Test Results After a minute, you'll start to have the results of your snapshot tests: OnlineOrNot Result Data

You can then click into the Result to see the data OnlineOrNot observed, and how it compares to the expected result: OnlineOrNot Results

You've done it!

Congratulations, you've now got an active GraphQL test checking your GraphQL responses for regressions!