Skip to content

Commit 38b7692

Browse files
committed
update for desktop UI
1 parent 50796e3 commit 38b7692

File tree

5 files changed

+26
-36
lines changed

5 files changed

+26
-36
lines changed

_docs/en/http-stubs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The meaning of the stub is that when an HTTP GET request is sent to the `Manual`
3030
The default port number of the `Manual` mock server is `8094`, and it can be changed under the `Settings` tab of the mock server.
3131

3232
### Test the Stub
33-
Open a new tab in your browser, and go to `http://localhost:8094/some/thing`, and you'll see response body `Hello!` on the page.
33+
Open your browser, and go to `http://localhost:8094/some/thing`, and you'll see response body `Hello!` on the page.
3434

3535
![Quick Play Stub Invocation](../../screenshots/http-stubs/quick-play-stub-invocation.png)
3636

_docs/en/maintenance.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ API Test Base application stores data in a folder called `<ATB_DATA_DIR>`. Follo
1515

1616
{% endtab %}
1717

18-
{% tab data-folder Mac OS %}
18+
{% tab data-folder macOS %}
1919

2020
```
2121
~/Library/Application Support/API Test Base
@@ -35,23 +35,25 @@ The first time you launch the application, below new folders are created automat
3535

3636
```
3737
database - where system database and a sample database are located. Both are H2 databases.
38-
System database is used to store all test cases, environments, endpoints, etc. you create using API Test Base.
39-
Sample database is for you to play with API Test Base basic features such as REST API testing or database testing. An Article table is in it.
38+
System database is used to store all test cases, environments, endpoints, etc. you create using ATB.
39+
Sample database is for you to play with ATB basic features such as REST API testing or database testing. An Article table is in it.
4040
41-
logs - where API Test Base application runtime logs are located.
41+
logs - where ATB application runtime logs are located.
4242
4343
lib - where you put external libraries when needed.
44+
45+
electron - where the Electron app data and logs are located. Not applicable to ATB Docker container.
4446
```
4547

4648
It is recommended that you back up `<ATB_DATA_DIR>/database` folder regularly. Remember to exit the application before backing up.
4749

4850
#### Changing Configurations
49-
To change configurations like port numbers, modify the `<ATB_DATA_DIR>/config.properties` file content, and restart API Test Base.
51+
To change configurations like port numbers, modify the `<ATB_DATA_DIR>/config.properties` file content, and restart ATB.
5052

5153
#### Changing \<ATB_DATA_DIR\>
52-
To change `<ATB_DATA_DIR>` to a different location, just set an environment variable `ATB_DATA_DIR=/path/to/the/new/location` on your operating system, and restart API Test Base.
54+
To change `<ATB_DATA_DIR>` to a different location, set an environment variable `ATB_DATA_DIR=/path/to/the/new/location` on your operating system, and restart ATB.
5355

54-
`Mac users`: to set environment variables for applications (launched from Spotlight, Dock, etc.), create a plist file under ~/Library/LaunchAgents folder, and restart the machine. For example: io.apitestbase.plist
56+
`macOS users`: to set environment variables for applications (launched from Spotlight, Dock, etc.), create a plist file under ~/Library/LaunchAgents folder, and restart the machine. For example: io.apitestbase.plist
5557

5658
```
5759
<?xml version="1.0" encoding="UTF-8"?>

_docs/en/quick-start.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,19 @@ key: docs-quick-start
99

1010
{% tab install Windows %}
1111

12-
Download installer `apitestbase-{{ site.atb_release_version }}.exe` from the [latest release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
12+
Download API Test Base `{{ site.atb_release_version }}` from the [latest release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
1313

14-
Double click the installer and follow through the normal Windows application installation process. You will likely get a warning dialog from Windows Defender SmartScreen, because the app hasn't been digitally signed by a Microsoft trusted Certificate Authority (which is expensive!). Click 'More info' on the dialog, and click 'Run anyway' to proceed installing API Test Base.
15-
16-
Once the installation finishes, you can launch API Test Base from Start Menu or Desktop shortcut.
14+
When running the setup or portable binary, you will likely get a warning dialog from Microsoft Defender SmartScreen, because the app hasn't been digitally signed by a Microsoft trusted Certificate Authority (which is expensive!). Click 'More info' on the dialog, and click 'Run anyway' to proceed.
1715

1816
First time launching, a Windows Defender Firewall alert will pop up. Check the `Private networks ...` option, uncheck the `Public networks ...` option, and click the `Allow access` button.
1917

20-
Once the application is launched, a system tray icon shows. Click the icon to bring up the menu, like below.
21-
22-
![System Tray Menu](../../screenshots/install-and-launch/system-tray-menu.png)
23-
24-
Select `Open ATB` to open API Test Base UI in your default browser.
25-
2618
{% endtab %}
2719

28-
{% tab install Mac OS %}
20+
{% tab install macOS %}
2921

30-
Download `apitestbase-{{ site.atb_release_version }}.dmg` from the [latest release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
22+
Download API Test Base `{{ site.atb_release_version }}` from the [latest release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
3123

32-
Double click the dmg and drag `API Test Base.app` to your /Applications folder.
33-
34-
Open the `/Applications/API Test Base.app` to launch API Test Base. A system tray icon shows. Click the icon to bring up the menu, like below.
35-
36-
![System Tray Menu](../../screenshots/install-and-launch/system-tray-menu.png)
37-
38-
Select `Open ATB` to open API Test Base UI in your default browser.
24+
Double click the dmg and drag `API Test Base.app` to your `/Applications` folder.
3925

4026
{% endtab %}
4127

@@ -55,7 +41,7 @@ docker run -d -t -v C:\Users\zheng\AppData\Roaming\ApiTestBaseDocker:/atb/data -
5541

5642
If not using host networking
5743
```
58-
// Windows or Mac OS host
44+
// Windows or macOS host
5945
docker run -d -t -v /data/folder/on/host:/atb/data --name apitestbase-{{ site.atb_release_version }} -p 8090:8090 apitestbase/apitestbase:{{ site.atb_release_version }}
6046
6147
// Linux host
@@ -71,14 +57,16 @@ Once the container is running, open `http://localhost:8090/ui` in a Chrome brows
7157
## Ad Hoc Invocation
7258
Suppose you want to invoke a REST API.
7359

74-
Right click anywhere in the left side pane, select `New Request` > HTTP, give it a name and press Enter. The request is created:
60+
Right click anywhere on the left side pane, select `New Request` > HTTP, give it a name and press Enter.
61+
62+
The request is created:
7563

7664
![New HTTP Request](../../screenshots/basic-use/new-http-request.png)
7765

7866
In the request edit view, under the Invocation tab, select Method `GET`, enter a URL like `http://localhost:8090/api/articles` (an API Test Base bundled API) and click the `Invoke` button.
7967

8068
![Ad Hoc HTTP Invocation](../../screenshots/basic-use/ad-hoc-http-invocation.png)
8169

82-
The request, as well as all the data you create in API Test Base, is automatically persisted (no Save button), so no need to worry about data loss across browser or machine restarts.
70+
The request, as well as all the data you create in API Test Base, is automatically persisted (no Save button), so no need to worry about data loss across app or machine restarts.
8371

8472
`Docker users`: if not using host networking, to enable ATB docker container to call your API on the host machine, use `host.docker.internal` as hostname in the request URL.

_docs/en/upgrade-from-old-version.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ key: docs-upgrade-from-old-version
1111

1212
`Exit API Test Base app` if it is running.
1313

14-
Download the latest API Test Base installer from the [release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
14+
Download the latest API Test Base version from the [release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
1515

16-
Running a new version installer will automatically uninstall the old ATB version and install the new version. It is typical for you to install the new version into the existing ATB installation directory.
16+
For the installer (setup exe), running a new version installer will automatically uninstall the old ATB version and install the new version. It is typical for you to install the new version into the existing ATB installation directory.
1717

18-
When running the new version installer, you'll see the same security warning as before. Refer to [Quick Start](/docs/en/quick-start) for how to resolve it.
18+
For the portable, just abandon the old version and start using the new version.
1919

2020
{% endtab %}
2121

22-
{% tab upgrade Mac OS %}
22+
{% tab upgrade macOS %}
2323

2424
`Exit API Test Base app` if it is running.
2525

26-
Download the latest API Test Base dmg from the [release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
26+
Download the latest API Test Base version from the [release page](https://github.com/apitestbase/apitestbase-release/releases/tag/{{ site.atb_release_version }}){:target="_blank"}.
2727

28-
Open the new dmg file, and you'll be able to drag the new version of `API Test Base.app` to your /Applications folder, `replacing` the old one.
28+
Open the new dmg file, and you'll be able to drag the new version of `API Test Base.app` to your `/Applications` folder, `replacing` the old one.
2929

3030
{% endtab %}
3131

Binary file not shown.

0 commit comments

Comments
 (0)