https://github.com/ct83/re-searcher-api

https://github.com/ct83/re-searcher-api

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ct83/re-searcher-api
• Owner: CT83
• License: apache-2.0
• Created: 2020-08-19T06:33:37.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-03T17:16:03.000Z (almost 6 years ago)
• Last Synced: 2025-03-02T18:19:46.035Z (over 1 year ago)
• Language: Python
• Size: 459 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Re-Searcher-API

This is an App to cache the search results made by APIs. 

## Setup - Development   

* Setup `.env` file, refer `.env.example` 

* `docker-compose up --build -d`

## Setup - Production  

* Setup `.prod-env` file, refer `.prod-env.example`

* `docker-compose -f docker-compose-prod.yml up --build -d`

## How to Use?  

* `curl -d '{"query": "Pink Car","engine": "bing"}' -X POST http://localhost/api/search  -H "Content-Type: application/json"`

## API Reference Docs

#### 1. Search - http://localhost/api/search

##### Request - GET

/search?query= 

##### Reponse 

`{

    "search_res": [

        {

            "url": "https://unsplash.com/s/photos/pink-car",

            "name": "Pink Car Pictures | Download Free Images on Unsplash"

        }...]

}`

## AWS Setup

1. No manual setup is required on AWS, you only need to supply the correct *Key & Secret tokens* in the *.prod-env* for the user

who has the "AmazonDynamoDBFullAccess" permission.

2. Then the results are automatically written to the DynamoDB Table. 

3. The table is automatically created on AWS DynamoDB if it does not already exist. 

`Check models.utils.init_tables`

### Screenshots

Here are some screenshots on how to create a new AWS User

![](./images/aws1.png)

![](./images/aws2.png)

![](./images/aws3.png)

![](./images/aws4.png)

## Screenshots

![](./images/curl.jpg)

* CURL - Git Bash

![](./images/dockerps.jpg)

* Docker PS

## Appendix

### Supported Engines

1. Bing API - This allows us to programmatically return search results from Bing

   

    Sample `{

            "query": "Pink Car",

            "engine": "bing"

        }`

    

    Read More 

    * https://azure.microsoft.com/en-in/services/cognitive-services/bing-web-search-api/

    * https://docs.microsoft.com/en-us/azure/cognitive-services/bing-web-search/

2. Mock API - This returns random strong and random urls, very useful for testing.   

        

    Sample `{

            "query": "Pink Car",

            "engine": "mock"

        }`

    

    Read More 

    * `app.search_api.mock_search.MockSearch`  

    

Factory allows us to add even more backends easily. - `api/app/search_api/factory.py `

### Snippets 

* `docker-compose down && docker-compose up --build -d && docker-compose logs --follow`