Skip to content

julio-alv/api-search

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Search

A simple API that uses Meilisearch as the engine for "List" endpoints, it uses an event driven backend to asynchronously update the index

Screenshot 2025-04-23 at 2 17 01 PM

Requirements

  • Go
  • Docker
  • Make

Running the Project

make sure you have a .env file setup (see .envrc for an example)

make

Endpoints

GET    http://localhost:8080/vehicles       HTTP/1.1
GET    http://localhost:8080/vehicles/:id   HTTP/1.1
POST   http://localhost:8080/vehicles       HTTP/1.1
PUT    http://localhost:8080/vehicles/:id   HTTP/1.1
DELETE http://localhost:8080/vehicles/:id   HTTP/1.1

List Endpoint query params

Note: make sure all query params are properly URL encoded

Param Description Example
search a general purpose search search=Bugatti
order a key-value pair to order the results by order=created_at:desc
filter filter by a specific query (see meilisearch docs for details filter=horse_power>500
size the maximum allowed size per page size=50
page the page to query into page=3

About

A simple HTTP API using MongoDB & Meilisearch

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published