|
|
|
# Technical Debt Toolbox - Execution as a Microservice
|
|
|
|
|
|
|
|
In this wiki page we describe how the Technical Debt Toolbox can be used per individual Microservice. More specifically, we describe how the three services that it provides (i.e., *TD Analysis and Refactorings*, *TD New Code*, and *Architecture Refactorings*) can be invoked, whereas intuitive examples are also provided, in an attempt to facilitate understanding.
|
|
|
|
|
|
|
|
## Execution of the Docker Container
|
|
|
|
|
|
|
|
Having the Technical Dent Toolbox Docker Container already deployed on your local machine (see the [Installation](technical-debt-toolbox-installation) page for more information), it can be started, paused, and stopped using common Docker commands.
|
|
|
|
|
|
|
|
## Invocation of the individual services (APIs)
|
|
|
|
|
|
|
|
After starting the Docker Container of the Technical Debt Toolbox back-end, its web services are up and running. The Technical Debt Toolbox is accessible through the following end point:
|
|
|
|
|
|
|
|
```
|
|
|
|
<local_IP>:<defined_port>/<service>
|
|
|
|
```
|
|
|
|
|
|
|
|
where the <local_IP> is the IP of the local machine on which the Technical Debt Toolbox Docker Container has been deployed, whereas the <defined_port> is the port of the Server that is defined by the user during the installation and <service> is the service invocation that the user wants to call (for example: principalSummary, interestSummary).
|
|
|
|
|
|
|
|
In order to invoke any of the available web services, the right resource (i.e., end point) should be used. The resources (i.e., end points) of the web services of the Technical Debt Toolbox are listed below:
|
|
|
|
|
|
|
|
- **TD Analysis**: /
|
|
|
|
- **TD New Code**: /
|
|
|
|
- **Design Refactorings** /
|
|
|
|
- **Code Refactorings** /
|
|
|
|
|
|
|
|
In the following, a more detailed description of how these services can be used is provided. Please use the following links to navigate more easily within the page:
|
|
|
|
|
