You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/en/maintenance.md
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ API Test Base application stores data in a folder called `<ATB_DATA_DIR>`. Follo
15
15
16
16
{% endtab %}
17
17
18
-
{% tab data-folder Mac OS %}
18
+
{% tab data-folder macOS %}
19
19
20
20
```
21
21
~/Library/Application Support/API Test Base
@@ -35,23 +35,25 @@ The first time you launch the application, below new folders are created automat
35
35
36
36
```
37
37
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.
40
40
41
-
logs - where API Test Base application runtime logs are located.
41
+
logs - where ATB application runtime logs are located.
42
42
43
43
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.
44
46
```
45
47
46
48
It is recommended that you back up `<ATB_DATA_DIR>/database` folder regularly. Remember to exit the application before backing up.
47
49
48
50
#### 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.
50
52
51
53
#### 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.
53
55
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
Copy file name to clipboardExpand all lines: _docs/en/quick-start.md
+10-22Lines changed: 10 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -9,33 +9,19 @@ key: docs-quick-start
9
9
10
10
{% tab install Windows %}
11
11
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"}.
13
13
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.
17
15
18
16
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.
19
17
20
-
Once the application is launched, a system tray icon shows. Click the icon to bring up the menu, like below.
Select `Open ATB` to open API Test Base UI in your default browser.
25
-
26
18
{% endtab %}
27
19
28
-
{% tab install Mac OS %}
20
+
{% tab install macOS %}
29
21
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"}.
31
23
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.
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.
79
67
80
68

81
69
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.
83
71
84
72
`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.
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"}.
15
15
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.
17
17
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.
19
19
20
20
{% endtab %}
21
21
22
-
{% tab upgrade Mac OS %}
22
+
{% tab upgrade macOS %}
23
23
24
24
`Exit API Test Base app` if it is running.
25
25
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"}.
27
27
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.
0 commit comments