mirror of
https://github.com/karust/openserp.git
synced 2026-08-24 00:46:32 +08:00
91 lines
3.5 KiB
Markdown
91 lines
3.5 KiB
Markdown
# OpenSERP (Search Engine Results Page)
|
|
|
|
|
|
[](https://goreportcard.com/report/github.com/karust/openserp)
|
|
[](https://pkg.go.dev/github.com/karust/openserp)
|
|
[](https://github.com/karust/openserp/releases)
|
|
<!--  -->
|
|
API access for search engines results if available isn't free.
|
|
|
|
Using OpenSERP, you can get search results from **Google**, **Yandex**, **Baidu** via API or CLI!
|
|
|
|
See [Docker](#docker) and [CLI](#cli) usage examples below ([search](#search), [images](#images)).
|
|
|
|
## Docker usage <a name="docker"></a> 🐳
|
|
* Run API server:
|
|
```bash
|
|
# Use prebuilt image
|
|
docker run -p 127.0.0.1:7000:7000 -it karust/openserp serve -a 0.0.0.0 -p 7000
|
|
|
|
# Or build one and run using docker-compose.yaml
|
|
docker-compose up --build
|
|
```
|
|
|
|
### Request parameters
|
|
| Param | Description |
|
|
|-------|--------------------------------------------------------------|
|
|
| text | Text to search |
|
|
| lang | Search pages in selected language (`EN`, `DE`, `RU`...) |
|
|
| date | Date in `YYYYMMDD..YYYYMMDD` format (e.g. 20181010..20231010) |
|
|
| file | File extension to search (e.g. `PDF`, `DOC`) |
|
|
| site | Search within a specific website |
|
|
| limit | Limit the number of results
|
|
| answers | Include google answers as negative rank indexes (e.g. `true`, `false`)
|
|
|
|
### **Search**
|
|
### *Example request*
|
|
Get 20 **Google** results for `hello world`, only in English:
|
|
```
|
|
GET http:/127.0.0.1:7000/google/search?lang=EN&limit=20&text=hello world
|
|
```
|
|
You can replace `google` to `yandex` or `baidu` in query to change search engine.
|
|
|
|
|
|
|
### *Example response*
|
|
```JSON
|
|
[
|
|
{
|
|
"rank": 1,
|
|
"url": "https://en.wikipedia.org/wiki/%22Hello,_World!%22_program",
|
|
"title": "\"Hello, World!\" program",
|
|
"description": "A \"Hello, World!\" program is generally a computer program that ignores any input, and outputs or displays a message similar to \"Hello, World!\".",
|
|
"ad": false
|
|
},
|
|
]
|
|
```
|
|
### **Images** **[WIP]**
|
|
### *Example request*
|
|
Get 100 **Google** results for `golden puppy`:
|
|
```
|
|
GET http://127.0.0.1:7000/google/image?text=golden puppy&limit=100
|
|
```
|
|
|
|
|
|
## CLI <a name="cli"></a> ⌨️
|
|
* Use `-h` flag to see commands.
|
|
* You can use `serve` command to serve API:
|
|
```bash
|
|
openserp serve
|
|
```
|
|
* Or print results in CLI using `search` command:
|
|
```bash
|
|
openserp search google "how to get banned from google fast" # Change `google` to `yandex` or `baidu`
|
|
```
|
|
As a result you should get JSON output containting search results:
|
|
```json
|
|
[
|
|
{
|
|
"rank": 1,
|
|
"url": "https://www.cyberoptik.net/blog/6-sure-fire-ways-to-get-banned-from-google/",
|
|
"title": "11 Sure-Fire Ways to Get Banned From Google | CyberOptik",
|
|
"description": "How To Get Banned From Google · 1. Cloaking: The Art of Deception · 2. Plagiarism: Because Originality is Overrated · 3. Keyword Stuffing: More is Always Better · 4 ...",
|
|
"ad": false
|
|
},
|
|
]
|
|
```
|
|
|
|
## License
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
|
|
|
|
## Bugs + Questions 👾
|
|
If you have some issues/bugs/questions, feel free to open an issue. |