API

После запуска gofound отслеживает один TCP-порт и принимает поисковые запросы от клиентов. Для обработки HTTP-запросов используется фреймворк gin.

Поддержка нескольких баз данных

С версии 1.1 поддерживается несколько баз данных. В API-интерфейсе можно указать базу данных с помощью параметра get.

Если параметр не указан, по умолчанию используется база данных default.

Пример: api/index?database=db1. Остальные параметры post остаются неизменными.

При указании несуществующей базы данных будет автоматически создана новая база данных. Чтобы удалить её, просто удалите каталог этой базы данных и перезапустите gofound.

Увеличение или изменение индекса

Необходимо указать имя базы данных в параметре query database=default.

Запрос

Параметры запроса (params-data)

• POST /api/index

{
  "id": 88888,
  "text": "深圳北站",
  "document": {
    "title": "阿森松岛所445",
    "number": 223
  }
}

• Команда

curl -H "Content-Type:application/json" -X POST --data '{"id":88888,"text":"深圳北站","document":{"title":"阿森松岛所445","number":223}}' http://127.0.0.1:5678/api/index?database=default

Ответ

{
  "state": true,
  "message": "success"
}

Пакетное увеличение или изменение индекса

Процесс аналогичен добавлению одного индекса, но необходимо использовать массив для передачи нескольких объектов JSON в качестве параметров. Например:

[
  {
    "id": 88888,
    "text": "深圳北站",
    "document": {
      "title": "阿森松岛所445",
      "number": 223
    }
  },
  {
    "id": 22222,
    "text": "北京东站",
    "document": {
      "title": "123123123",
      "number": 123123
    }
  }
]

Удаление индекса

Аналогично другим интерфейсам, необходимо указать имя базы данных в параметрах запроса database=default.

Запрос

• POST /api/remove

{
  "id": 88888
}

• Команда

curl -H "Content-Type:application/json" -X POST --data '{"id":88888}' http://127.0.0.1:5678/api/remove?database=default

Ответ

{
  "state": true,
  "message": "success"
}

Запрос индекса

GoFound предоставляет способ поиска по тексту. В отличие от других NoSQL баз данных, GoFound не поддерживает другие виды запросов к документам.

Запрос

Параметры запроса (params-data)

Highlight

После настройки будут выделены соответствующие ключевые слова с использованием префикса preTag и суффикса postTag.

• Пример

{
  "query": "上海哪里好玩",
  "page": 1,
  "limit": 10,
  "order": "desc",
  "highlight": {
    "preTag": "<span style='color:red'>",
    "postTag": "</span>"
  }
}

• POST /api/query

{
  "query": "深圳北站",
  "page": 1,
  "limit": 10,
  "order": "desc"
}

• Команда

curl -H "Content-Type:application/json" -X POST
``` **Запрос:**

{ "query": "深圳北站", "page": 1, "limit": 10, "order": "desc" }

**Ответ:**

Объект запроса: «深圳北站».

Страница: 1.

Ограничение: 10.

Сортировка: по убыванию. ### Запрос параметров
| Поле | Тип | Обязательное | Описание |
|-----|------|----------|-------|
| q | string | ключевое слово |

### Запрос
`curl http://127.0.0.1:5678/api/word/cut?q=上海和深圳哪个城市幸福指数高`

### Ответ
```json
{
  "state": true,
  "message": "success",
  "data": [
    "上海",
    "深圳",
    "哪个",
    "город",
    "счастье",
    "индекс"
  ]
}