Skip to content

Commit 13a23c7

Browse files
Merge pull request #309 from suvmanda/update-function-documentation-runServerJava
update function documentation runServerJava
2 parents ab5c1ff + 8caf49a commit 13a23c7

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

documentation/Functions.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,9 +402,17 @@ Note:
402402

403403

404404
### runServerJava <a name="runServerJava"></a>
405+
This function will run your Java application on server.Parameter and assertion information you need to use properly, which is mentioned below.In Katacoda the command will be executed in a new terminal.
405406
#### parameter
406-
1. Path to the server directory within the java project.
407-
2. Assertion information. Only needed for the console runner to check if the server was started properly.
407+
This functions consists of two parameters.
408+
1. 1st Parameter:
409+
- **Required**
410+
- **Type**- String
411+
- **Description**- Path to the server directory within the Java project.
412+
2. 2nd Parameter:
413+
- **Required**
414+
- **Type**- JSON object
415+
- **Description**- Assertion information. Only needed for the console runner to check if the server was started properly.
408416
#### example
409417
runServerJava("devonfw/workspaces/main/jump-the-queue/java/jtqj/server", { "startupTime": 40, "port": 8081, "path": "jumpthequeue" })
410418

@@ -414,6 +422,9 @@ port: Port on which the server is running
414422
path: The URL path on which is checked if the server is running
415423

416424
If the tutorial should be tested on the console environment, you have to specify a port.
425+
426+
Note: For this command the devonfw-ide is not necessarily needed. Maven has to be installed. So if someone installs Maven before (e.g. with a setup script), then the command should also work.The command uses the Spring Boot Maven Plugin to run the Java application. So at the moment only Spring applications are supported.
427+
417428
***
418429

419430
### npmInstall <a name="npmInstall"></a>

0 commit comments

Comments
 (0)