Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/szerhusenbc/apisimulator-docker-image
Custom docker image for API Simulator that is a configuration-driven tool for creating and running API simulations
https://github.com/szerhusenbc/apisimulator-docker-image
apis docker-image mocking simulation test test-automation testing-tools
Last synced: 7 days ago
JSON representation
Custom docker image for API Simulator that is a configuration-driven tool for creating and running API simulations
- Host: GitHub
- URL: https://github.com/szerhusenbc/apisimulator-docker-image
- Owner: szerhusenBC
- License: mit
- Created: 2024-09-17T08:39:56.000Z (16 days ago)
- Default Branch: main
- Last Pushed: 2024-09-17T10:35:05.000Z (16 days ago)
- Last Synced: 2024-09-26T09:01:36.855Z (7 days ago)
- Topics: apis, docker-image, mocking, simulation, test, test-automation, testing-tools
- Language: Makefile
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# apisimulator-docker-image
Custom docker image for API Simulator that is a configuration-driven tool for creating and running API simulations. The image is based on the
[API Simulator for Easy and Realistic API Simulations](https://apisimulator.io/). There is also an
[official Docker image](https://hub.docker.com/r/apimastery/apisimulator) available, but
[this image](https://hub.docker.com/repository/docker/szerhusenbc/apisimulator/general) is much smaller and supports real time reloading when API configuration
files are changed.
## Usage
You can run the docker image with the following command
```bash
docker run -d -p 6090:6090 --name apisimulator szerhusenbc/apisimulator:latest
```
or using Docker compose
```yaml
version: '3.8'
services:
apisimulator:
image: szerhusenbc/apisimulator:latest
container_name: apisimulator
ports:
- "6090:6090"
```
The API Simulator is now available and contains example simulations:
* Hello World: http://localhost:6090
* Greeting with path parameter: http://localhost:6090/greetings/John
* Greeting with query parameter: http://localhost:6090/hi or http://localhost:6090/hi?name=John
* Greeting with random phrase: http://localhost:6090/hey
### Custom simulations
It is possible to mount a directory with custom simulations to the docker container:
```bash
docker run -d -p 6090:6090 -v /path/to/my/simulations:/simulations --name apisimulator szerhusenbc/apisimulator:latest
```
or using Docker compose
```yaml
version: '3.8'
services:
apisimulator:
image: szerhusenbc/apisimulator:latest
container_name: apisimulator
ports:
- "6090:6090"
volumes:
- type: bind
source: /path/to/my/simulations
target: /simulations
```
Now the API Simulator is available with the custom simulations. **Everytime a file in the simulations directory is changed, the API Simulator will restart
internally with the new configurations.**
You can also mount out the logs directory to get access to the logs. You have to mount the path `/apisimulator-http/logs/` to a directory on your host system.
### Documentation
The official API Simulator documentation is available at https://apisimulator.io/docs/index.html.
## Makefile
The Makefile provides different targets for building and running the docker image. By running `make` or `make help`, the available targets are shown.