| ... | ... | @@ -64,3 +64,20 @@ In the following, a more detailed description of how these services can be used |
|
|
|
|
|
|
|
## TD Analysis Service
|
|
|
|
|
|
|
|
The entry point of the TD Toolbox of Breaking Point Tool is a RESTful web server written in JavaScript using the Express framework. Express.js, or simply Express, is a web application framework for Node.js, released as free and open-source software under the MIT License. It is designed for building web applications and APIs. To decouple the functionalities, a web service per task has been created. The main web-services supported by TD Breaking Point Tool, return data in a json format and are listed below:
|
|
|
|
- **TD Principal:** This web service is responsible for generating TD Principal for a given software application. The metrics are calculated at project, package and file level.
|
|
|
|
- **TD Interest:** This web service is responsible for generating TD Interest for a given software application. The metrics are calculated at project, package and file level.
|
|
|
|
|
|
|
|
### TD Principal
|
|
|
|
|
|
|
|
**End Points - URLS**
|
|
|
|
{GET} /principalIndicators/search?projectID=
|
|
|
|
{GET} /principalSummary/search?projectID=
|
|
|
|
|
|
|
|
|
|
|
|
| Parameter | Description | Required | Type |
|
|
|
|
|:------------:|:---------------------------------------------------------------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
|
| projectID | The name of the project. The name should be the same as the name that given through the analysis phase. | Yes | String |
|
|
|
|
|
|
|
|
|
|
|
|
|
