add REST API command line interface 'rest-cli'.

[MusclePr]

Context

Like rcon-cli, it supports a REST API command line interface.

Choices

Since rcon-cli is convenient, I also tried imitating rest-cli.

Test instructions

1. download test script.
   test-rest-cli.zip

2. extract to project root.

unzip test-rest-cli.zip
chmod +x test-rest-cli.sh

4. build docker image with debug tag.

docker build -t thijsvanloef/palworld-server-docker:debug .

5. run test-rest-cli.sh and connect server from client manualy.

$ ./test-rest-cli.sh 
[+] Running 1/2
 ⠸ Network palworld-server-docker_default  Created
  ✔ Container palworld-server               Started 
wait healthy...... done.
TEST ... docker exec -i palworld-server rest-cli
OK
TEST ... docker exec -i palworld-server rest-cli -h
OK
TEST ... docker exec -i palworld-server rest-cli announce -h
OK
TEST ... docker exec -i palworld-server rest-cli ban -h
OK
TEST ... docker exec -i palworld-server rest-cli unban -h
OK
TEST ... docker exec -i palworld-server rest-cli kick -h
OK
TEST ... docker exec -i palworld-server rest-cli shutdown -h
OK
TEST ... docker exec -i palworld-server rest-cli unknown foo bar
OK
TEST ... docker exec -i palworld-server rest-cli info
OK
TEST ... docker exec -i palworld-server rest-cli settings
OK
TEST ... docker exec -i palworld-server rest-cli metrics
OK
SERVER ADDRESS: 172.21.57.49:8211
TEST ... docker exec -i palworld-server rest-cli players
wait login..OK
TEST ... docker exec -i palworld-server rest-cli announce "Hello PalWorld!"
OK
TEST ... docker exec -i palworld-server rest-cli announce '{"message":"Logout to continue tests."}'
OK
TEST ... cat json-file | docker exec -i palworld-server rest-cli announce -
OK
TEST ... docker exec -i palworld-server rest-cli save
OK
TEST ... docker exec -i palworld-server rest-cli shutdown 300
OK
wait shutdown or logout......logout to stop now
TEST ... docker exec -i palworld-server rest-cli stop
OK
... done.
TEST ... docker exec -i palworld-server rest-cli info
OK
[+] Running 2/2
 ✔ Container palworld-server               Removed
 ✔ Network palworld-server-docker_default  Removed

Checklist before requesting a review

• I have performed a self-review/test of my code
• I've added documentation about this change to the docs.
• I've not introduced breaking changes.
• My changes do not violate linting rules.

[MusclePr]

Symbolic links are just a preference.

[MusclePr]

"save" and "stop" require the method to be POST.

[MusclePr]

Due to an increase in minor fixes, I will temporarily organize the commits.

[MusclePr]

The symbolic link /usr/local/bin/rest-cli refers to helper_functions.sh in the same location as the original rest_api.sh.

[MusclePr]

Here we are just converting the CLI parameters to JSON when the parameters are not JSON.

[MusclePr]

I added a line break because the output JSON ends with "}".

[thijsvanloef]

Hi @MusclePr ! Thanks again for the REST API PR's! Will take a look at it tonight

[MusclePr]

Fixed a part of README.md.

[thijsvanloef]

Sorry I took so long, got sidetracked, merging!