Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
appatalks authored Jul 6, 2024
1 parent 4da5ea2 commit b978e3e
Showing 1 changed file with 9 additions and 54 deletions.
63 changes: 9 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,76 +49,31 @@ A simple FIFO API Gateway for managing API calls, storing them in MySQL, and pro
curl -k -X GET https://127.0.0.1:5000/api/deliver
```

(Remeber to use Valid Certificates, otherwise accept self-signed as valid with ```curl -k``` flag)
(Use ```valid certificates```, otherwise accept ```self-signed``` as valid with ```curl -k``` flag)

### Example: GitHub API Integration

- Save GitHub API Call:
```bash
curl -k -X POST https://127.0.0.1:5000/api/save -H "Content-Type: application/json" -d '{"data": "{\"headers\": {\"Accept\": \"application/vnd.github+json\", \"Authorization\": \"Bearer
<TOKEN>\", \"X-GitHub-Api-Version\": \"2022-11-28\"}, \"url\": \"https://git.example.com/api/v3/user\"}"}'
{"status": "success"}
```

- Retrieve GitHub API Call:
```bash
bash github_api_delivery.sh
{ "login": "octocat", "id": 10, ... }
```
### Example: OpenAI API Integration
- Save OpenAI API Call
```bash
curl -k -X POST https://127.0.0.1:5000/api/save -H "Content-Type: application/json" -d '{"data": "{\"openai_token\": \"<OPENAI_API_KEY>\", \"data\": {\"model\": \"gpt-4\", \"messages\":
[{\"role\": \"system\", \"content\": \"You are a helpful assistant.\"}, {\"role\": \"user\", \"content\": \"Hello!\"}]}}"}'
{"status":"success"}
```
- Retrieve OpenAI API Call:
```bash
bash openai_api_delivery.sh
{ "id": "c***", "object": "chat.completion", "created": 1***, "model": "gpt-4-0613", "choices": [ { "index": 0, "message": { "role": "assistant",
"content": "Hello! How can I assist you today?" } ... }
```
### Example: Yahoo Finance API Integration
- Save Yahoo Finance API Call
```bash
curl -k -X POST https://localhost:5000/api/save -H "Content-Type: application/json" -d '{"data": "{\"headers\": {\"Accept\":
\"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8\", \"url\":
\"https://query1.finance.yahoo.com/v8/finance/chart/AAPL?interval=1d\"}}"}'
{"status":"success"}
```
- Retrieve Yahoo Finance API Call:
```bash
bash api_fifo_yahoo.sh
{"chart":{"result":[{"meta":{"currency":"USD","symbol":"AAPL" ... },
```
### See [API Endpoint Integration Examples](delivery/README.md)

----

# Highlights
## Highlights

## Task Queue Management
### Task Queue Management

### Background Processing
#### Background Processing
- **Use Case**: Applications that need to manage background tasks.
- **Benefit**: Ensures tasks are processed in the order they were received.

### Job Scheduling
#### Job Scheduling
- **Use Case**: Managing job scheduling systems.
- **Benefit**: Ensures jobs are executed in a specific order.
- **Example**: Regularly process queued request in-line with endpoint ```ratelimit``` gates.

## Logging and Analytics
### Logging and Analytics

### Event Logging
#### Event Logging
- **Use Case**: Serving as an event logging system.
- **Benefit**: Events are stored and processed in the order they occur.

### Data Analytics
#### Data Analytics
- **Use Case**: Data analytics pipelines.
- **Benefit**: Processes data in the sequence it was received to maintain temporal consistency.

0 comments on commit b978e3e

Please sign in to comment.