Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/farman20ali/query_simulator
This project is a Quarkus-based Java application that simulates a data-fetching service. It operates by handling queries provided in text format, fetching relevant data without requiring variable creation. The project utilizes RESTful endpoints to handle input and provide structured outputs.
https://github.com/farman20ali/query_simulator
data-fetching java microservices postgresql postgresql-database quarkus rest-api simulator
Last synced: about 1 month ago
JSON representation
This project is a Quarkus-based Java application that simulates a data-fetching service. It operates by handling queries provided in text format, fetching relevant data without requiring variable creation. The project utilizes RESTful endpoints to handle input and provide structured outputs.
- Host: GitHub
- URL: https://github.com/farman20ali/query_simulator
- Owner: farman20ali
- Created: 2024-12-12T07:52:04.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-14T07:09:15.000Z (about 1 month ago)
- Last Synced: 2024-12-14T08:18:05.463Z (about 1 month ago)
- Topics: data-fetching, java, microservices, postgresql, postgresql-database, quarkus, rest-api, simulator
- Language: Java
- Homepage:
- Size: 191 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# query_simulator
backened development for react native app
# Quarkus Simulator
## Overview
This project is a Quarkus-based Java application that simulates a data-fetching service. It operates by handling queries provided in text format, fetching relevant data without requiring variable creation. The project utilizes RESTful endpoints to handle input and provide structured outputs.
---
## Features
- Fetch data dynamically using query strings.
- Supports POST requests for sending data.
- Simplified handling of file-based parameters.
- Example endpoint:
- `http://localhost:8002/irs/lov/ambulance_services`
---
## Sample POST Request
```json
{
"fileName": "mobile",
"params": "03003"
}
```
- Endpoint: `{{ _.irs_ip }}:{{ _.irs_port }}/irs/user`
- Query Example:
```sql
SELECT * FROM vehicle_involved;
SELECT * FROM users WHERE mobile_number='%s';
```
---
## Project Dependencies
### Core Framework
- **Quarkus**
### Database
- PostgreSQL
### Key Dependencies (from `pom.xml`):
- Quarkus RESTEasy
- Quarkus RESTEasy Jackson
- Quarkus Agroal
- Quarkus JDBC PostgreSQL
- Quarkus Hibernate Validator
- Quarkus SmallRye OpenAPI
- Quarkus SmallRye Metrics
- Quarkus SmallRye Health
- Quarkus Narayana JTA
- BCrypt for encryption (via `jbcrypt`)
- Kubernetes support
- Jib for container image creation
---
## Getting Started
### Prerequisites
- Java 11 or later
- Maven
- PostgreSQL database
### Running the Application
1. Clone the repository:
```bash
git clone
cd query_simulator
```
2. Build the project:
```bash
mvn clean install
```
3. Run the Quarkus application:
```bash
mvn quarkus:dev
```
### Configuration
Set the following environment variables in the application:
- `_.irs_ip` - IP address for the server.
- `_.irs_port` - Port for the server.
---
## Example Endpoints
### Fetching File Data
- **URL:** `http://localhost:8002/irs/lov/{fileName}`
- **Method:** GET
- **Description:** Fetches data based on the provided file name.
### Query Execution
- **URL:** `{{ _.irs_ip }}:{{ _.irs_port }}/irs/user`
- **Method:** POST
- **Payload Example:**
```json
{
"fileName": "mobile",
"params": "03003"
}
```
---
## Tags
- `Quarkus`
- `Simulator`
- `PostgreSQL`
- `Java`
- `REST API`
- `Data Fetching`
---
## Contributing
1. Fork the repository.
2. Create a feature branch:
```bash
git checkout -b feature-name
```
3. Commit changes:
```bash
git commit -m "Description of changes"
```
4. Push to the branch:
```bash
git push origin feature-name
```
5. Create a pull request.
---
## License
This project is licensed under the [MIT License](LICENSE).