-
Notifications
You must be signed in to change notification settings - Fork 0
The Web Package is a spring boot based implementation of a web service with full functionality of API Package. Together with the Open API initiative, it allows developer to implement their own custom clients using the service as man in the middle to communicate through a rest API.
In order to start communication, a developer either must generate themselves a client in a language of their choice or write their own implementation.
It's recommend to wrap the service to a Windows service by utilizing WinSW and run a compiled web service in background.
Once the service runs, a user must create a new client through client-controller, this is the core of every communication. With the ID of a client, a user can exchange information through rest to stealth at any time. At the end of scripting, either close service fully or remove the client from client manager through rest API.
Download the source code and use it as you want.
Go to Release Page and download a precompiled x64 image. Running such an image will be at your own risk.
Create a Fork of the repository through git and add your own custom implementation.
Create a new maven project on your own.
<repositories>
<repository>
<id>github</id>
<name>GitHub ScriptSDK Java Web</name>
<url>https://maven.pkg.github.com/stealth-scriptsdk/java-web</url>
<releases><enabled>true</enabled></releases>
<snapshots><enabled>false</enabled></snapshots>
</repository>
</repositories>Add this information to your pom.xml file and don't forget to add your local personal access token.
Install package through maven written by this instruction
This example utilize the online editor of swagger. This might result in restrictions of client generation.
- Open OpenAPI specification and download its content as .JSON file
- Open Online Editor
- Click on File → Import file and select .JSON file
- Verify that its content looks equal to your own OpenAPI implementation
- Click on Generate Client and select language of your choice
- Swagger will generate and download an out-of-the-box project implementation of client
- OpenAPI documentation http://localhost:8080/openapi
- OpenAPI specification http://localhost:8080/v3/api-docs
Note: The port depending on your personal settings.