https://github.com/aman7123/database-sys-api-sb
A MySQL parsing RESTful API made with @spring-projects!
https://github.com/aman7123/database-sys-api-sb
Last synced: 3 months ago
JSON representation
A MySQL parsing RESTful API made with @spring-projects!
- Host: GitHub
- URL: https://github.com/aman7123/database-sys-api-sb
- Owner: Aman7123
- Created: 2022-03-29T19:53:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-17T01:32:27.000Z (almost 3 years ago)
- Last Synced: 2025-01-14T02:29:04.650Z (5 months ago)
- Language: Java
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### database-sys-api-sb
* Version: 1.2.1
* Most up to date implementation will be found in branch `develop`.
* Creator: Aaron Renner
* This API project was created in Spring-Boot
### Introduction
This RESTful API provides database resources. This API is fully dynamic meaning it was ideally designed to not need any secific MySQL formatting, just plug-and-play!
### Documentation
* See the Swagger OpenAPI Specification: `https://app.swaggerhub.com/apis-docs/ARTechnology/database-sys-api/1.0.0`
* Postman collection and environment variables in `src/test/resources/postman`
### Getting Started
**Running Locally using IDE**
This project uses Spring profiles, and corresponding application properties .yaml files.
All values from the application properties can be overwritten by the environment!
* Use the following environment variables:
* ```spring.profiles.active=```
The profiles active environment variable is for selecting active config values. This project has a dev and prod but credentials are hidden!
Note: IDE specific development
* Eclipse - When modifying this API in Eclipse the VM arguments added to the runtime configuration will be prefixed with `-D`.
* Example: `-Dspring.profiles.active=dev`
**Running on the Command Line**
The command arguments in a terminal also follow the prefix `-D` rule.
```
mvn spring-boot:run -Dspring-boot.run.arguments="--spring.profiles.active=dev"
```
### Docker & Compose & Maven
This project includes a lightweight, portable maven executable that can be used in place of having maven installed.
You will still need Java installed.
When building this application for production I have included the Dockerfile that can allow for building, preparing
and executing all source code in the base directory. Using CI/CD this can all be automated and I will try to include
an example for using Github workflows.
### Contact
* Aaron Renner ([email protected])