Without any other options, this starts your server on `<localhost:8000>`.
The `--reload --reload-dir apiserver` options ensure, that any changes to files in the `apiserver`-directory will cause an immediate reload of the server, which is especially useful during development. If this is not required, just don't include the options.
More information about uvicorn settings (including information about how to bind to other network interfaces or ports) can be found [here](https://www.uvicorn.org/settings/).
### Testing
First ensure that the `pytest` package is installed.
Tests are located in the `apiserver_tests` directory. They can be executed by simply running `pytest` while in the project folder.
If more test-files should be added, they should be named with a `test_` prefix and put into a similarily named folder, so that they can be auto-detected.
The `context.py` file helps with importing the apiserver-packages, so that the tests function independent of the local python path setup.
### Using the docker image
#### Building the docker image
To build the docker image of the current version, simply run
```bash
docker built -t datacatalog-apiserver ./apiserver
```
while in the project root directory.
`datacatalog-apiserver` is a local tag to identify the built docker image.
#### Running the docker image
To run the docker image in a local container, run
```bash
docker run -d--name <container name> -p 127.0.0.1:<local_port>:80 datacalog-apiserver
```
`<container name>` is the name of your container, that can be used to refer to it with other docker commands.
`<local_port>` is the port of your local machine, which will be forwarded to the docker container. For example, if it is set to `8080`, you will be able to reach the api-server at http://localhost:8080.
#### Stopping the docker image
To stop the docker image, run
```bash
docker stop <container name>
```
Note, that this will only stop the container, and not delete it fully. To do that, run
```bash
docker rm <container name>
```
For more information about docker, please see the [docker docs](https://docs.docker.com)
Without any other options, this starts your server on `<localhost:8000>`.
The `--reload --reload-dir apiserver` options ensure, that any changes to files in the `apiserver`-directory will cause an immediate reload of the server, which is especially useful during development. If this is not required, just don't include the options.
More information about uvicorn settings (including information about how to bind to other network interfaces or ports) can be found [here](https://www.uvicorn.org/settings/).
## Using the docker image
### Building the docker image
To build the docker image of the current version, simply run
```bash
docker built -t datacatalog-apiserver .
```
while in the same directory as the Dockerfile.
`datacatalog-apiserver` is a local tag to identify the built docker image.
### Running the docker image
To run the docker image in a local container, run
```bash
docker run -d--name <container name> -p 127.0.0.1:<local_port>:80 datacalog-apiserver
```
`<container name>` is the name of your container, that can be used to refer to it with other docker commands.
`<local_port>` is the port of your local machine, which will be forwarded to the docker container. For example, if it is set to `8080`, you will be able to reach the api-server at http://localhost:8080.
### Stopping the docker image
To stop the docker image, run
```bash
docker stop <container name>
```
Note, that this will only stop the container, and not delete it fully. To do that, run
```bash
docker rm <container name>
```
For more information about docker, please see the [docker docs](https://docs.docker.com)
