Skip to content

Search API is RESTful service for indexing and searching documents. It allows users to submit a local directory and query the indexed documents with single words or sentences.

Notifications You must be signed in to change notification settings

jfonsecadev/search-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Document Indexing and Search API

This project implements a RESTful service for indexing and searching documents. It allows users to submit a local directory URI to create an in-memory index of files and supports querying the index with single words or sentences.

Getting Started

Prerequisites
Java 17
Gradle 6.x

Building the Project

To build the project, run the following command in the project root directory:

./gradlew clean build

Running the Application

After successfully building the project, you can run it using:

./gradlew bootRun

The service will start and be available at http://localhost:8080.

Usage

After starting the service, you can use the following endpoints:

POST /index: Endpoint to submit a directory for indexing.
GET /search: Endpoint to search the indexed documents.

Additionally, there's also the default actuator endpoints.

About

Search API is RESTful service for indexing and searching documents. It allows users to submit a local directory and query the indexed documents with single words or sentences.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages