Getting Started

New Project

When you start the application you get an empty project that looks like this.

Create a Website

You can create a Website from scratch or you can import a WADL or JSON-formatted OpenAPI document (YAML is not currently supported). Click on the New Website button to get to the following screen.

Enter a URL for the Website you want to create. The URL can be as simple as a domain name or as complicated as a URL that contains a scheme, domain, port, path with path parameters and a query string at the end. Hyperlyn will create the corresponding website and path of resources.

Here are some examples of paths you can enter

• localhost:8080
• localhost/userapi/v{version}/users/{username}?details=all
• https:localhost/userapi/info

Hyperlyn will also parse path parameters and attach them to the corresponding resources and the query string. Query string parameters will normally be attached to the last resource but, if you choose the Add Default GET Request Template option, the query parameters will be attached to the request template.

Enter the information below.

Click on the OK button to create the Website.

Elements of the User Interface

In the Navigator — the left-hand side pane — you can see the newly created Website — hyperlyn.io:443. In the center you can see the root Resource and a Request Template. In the Inspector — the right-hand side pane — you can see the properties of the Website.

If you select the newly created root Resource you will see its properties in the Inspector.

If you select the other object in the project, the newly created Request Template, you will see its properties in the Inspector.

Send a First Request

Next, we can send a first request from Hyperlyn.

Right click on the Request Template to get to its context menu. Then, select Send Request with Defaults to send a request right away, with default values filled in for any parameters.

You can select the Http Exchange from the Website Log to get its main properties displayed in the Inspector. You will also be able to see information on the Request and Response in the two panes at the bottom of the center area — we call this area the Debugger.

If you now select the root Resource again, you will notice that two cookie Parameters have automatically been attached to it. These two cookies came with the Response.

Send a Second Request

Finally, we can try a second request, from the root Resource context menu. Right-click on the Resource to get to its context menu and then select Send GET Request with Defaults. This will send a GET request right away, with default values filled in for any Parameters.

This time, because Hyperlyn saved the cookies from the first response, it will be able to send them along with the second one. Notice the Cookie header in the Debugger request pane.

You can now save your project and this completes your getting started tutorial.

Last updated on 2023-12-05