Web

Summary

The Web Package is a spring boot based implementation of a webservice with full functionality of ApiPackage. Together with the OpenAPI initiative it allows developer to implement their own custom clients using the service as man in the middle to communicate through rest api.

In order to start communication, a developer either must generate themself a client in a language of their choice or write their own implementation.

Its recommend to wrap the service to a windows service by utilizing WinSW and run a compiled webservice 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 informations 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.

📦 Installation

Download Source

Download the source code and use it as you want.

Download Release

Go to Release Page and download a precompiled x64 image. Running such image will be at your own risk.

Fork

Create a Fork of repository through git and add your own custom implementation.

Maven

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

Generate a Rest Client

This example utilize the online editor of swagger. This might result in restrictions of client generation.

1. Open OpenAPI specification and download its content as .json file
2. Open Online Editor
3. Click on File -> Import file and select .json file
4. Verify that its content looks equal to your own OpenAPI implementation
5. Click on Generate Client and select language of your choice
6. Swagger will generate and download an out of the box project implementation of client

Documentation

• OpenAPI documentation http://localhost:8080/openapi
• OpenAPI specification http://localhost:8080/v3/api-docs

Note: The port dependings on your personal settings.

Source

• Github Repository