Add basic REST API and docker build for easier integration - #84
Merged
Conversation
tomarnepedersen
approved these changes
Feb 20, 2026
tomarnepedersen
left a comment
tomarnepedersen
left a comment
Collaborator
There was a problem hiding this comment.
Tested and found ok.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The rationale behind this PR is to make the ship traffic generator easier to integrate with by providing a basic REST API, as well as a docker build and Github workflow for pushing the image to a registry.
The REST API supports generating situations from an input JSON that contains data on the situation, own ship, target ships, and encounter settings. These are passed to the existing generator, which has been slightly modified just to support generating both from file (which the current CLI uses), and JSON input, with the same code.
The API can also be used to return any baseline situation by it's id. OpenAPI docs are provided.