Skip to content
Snippets Groups Projects
Commit a858fbb4 authored by Mirco Nasuti's avatar Mirco Nasuti
Browse files

update README

parent ddbeb9fb
No related branches found
No related tags found
No related merge requests found
## Introduction
This is the MIP implementation.
This is the MIP backend.
## Usage
Build the project with `./build` and run it with `./run`.
## API Documentation using Swagger (Springfox)
The API documentation is available at `<BASE URL>/swagger-ui.html`. A JSON version is available at `<BASE URL>/v2/api-docs`
## TODO
* Implement SoapUI tests;
* Clean code (both back-end front-end);
* Sync with original Swagger description;
* Externalize configuration (DB parameters, security enabled/disabled, ...);
* Make user tests with multiple users;
* Fix bugs.
## BUGS
* Export PDF does not work;
### Maintenance
* To keep an updated API documentation, the developers should keep synchronized both the auto-generated swagger file (from Java annotations) with the hand written one. You can follow this method to get a YAML description from the Java-annotated code:
* Add annotations to the Java code;
* Get JSON from `<BASE URL>/v2/api-docs`;
* Convert JSON to YAML on [http://jsontoyaml.com](http://jsontoyaml.com).
\ No newline at end of file
* Build the project: `./build.sh`
* Run the project: `./run.sh`
* Show live logs: `./log.sh` (CTRL+C to quit)
* Stop and remove the running container: `./halt.sh`
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment