Last Updated: 11/28/23
This is the API and backend code for the Blockchain Project.
This back end serves as the API for the Blockchain Project.
This API will service requests from the Blockchain Admin Web Client and Blockchain Field Mobile Client.
This API is currently a hybrid of the Node API and the Node Manager API, which will be decoupled in upcoming development.
As-is, this API can be fully utilized by running separate instances loaded with different property configurations.
These instance groups should contain exactly one Node Manager API instance running from 8080
and one or more
Node API instance(s) running from 9000
and up.
The ports can be set in the application.properties
file.
Follow the instructions below to run the API locally.
- Start an instance of the Node Manager API on port
8080
. - Start one or more instances of the Node API on ports
9000
and up.- These instances will attempt to register themselves to the Node Manager API on startup.
Build and Compile
mvn package
Run Unit Tests
mvn test
Generate Javadocs
mvn javadoc:javadoc
-
Export the Blockchain API Collection to Postman for testing and development.
-
Review the Endpoints for a list of current available endpoints.
- Execute requests locally in IDE using ENDPOINTS.http.
The aim of this API is to provide service to the client-side structure.
This API is a component of the Blockchain Project. It works as the back-end code to provide services to the following clients:
Feel free to download, modify, or use in any way.
Feedback welcome.
Developer: Hunter Yavitz