search

agile-learning-institute / mentorHub-search-api

A Typescript API that uses data from the backing Elasticsearch Database
Apache License 2.0
1 stars 0 forks source link

readme

mentorhub-search-api

DISCLAIMER

The Opensearch container is quite big, roughly 1.3 GB. This might present a problem for those on a metered connection looking to contribute.

Overview

This is a simple Typescript API that provides search results from the search database. This API uses data from a backing Elasticsearch Database.

Here are all of the repositories in the mentorHub system The OpenAPI specifications for the API can be found in the docs folder, and are served here

Prerequisites

Optionally

Customize configuration

See Tsconfig Reference

Contributing

The typescript files found in ./src/ are used to configure and start an API that will listen to requests on port 8081. to install dependencies and run locally. You can run the backing service with 

mh up opensearchonly

or if you don't have MentorHub Developer Edition installed:

docker run -d -p 9200:9200 -e "discovery.type=single-node" -e "plugins.security.disabled=true" -e "OPENSEARCH_INITIAL_ADMIN_PASSWORD:Z3i**BEl6YTJsDKrK3AgVO" opensearchproject/opensearch:2.12.0

Build and test the container

Use the following command to build and run the container locally. See here for details on how to stop/start the database.

../src/docker/docker-build.sh

After that command completes successfully you can verify it worked successfully by running curl tests or postman to confirm the build.

Local API Testing with CURL

Get search results

Note: You can change the "query: jame" header to another query. Just replace the text on the right-side of the colon. "query: <your-query>"

curl -X GET "http://localhost:8081/api/search/" -H  "accept: application/json" -H  "query: jame"

Get API health

curl -X GET "http://localhost:8081/api/health/" -H  "accept: */*"

Get config information

curl -X GET "http://localhost:8081/api/config/" -H  "accept: */* "

Testing the API with Postman

  1. Download and install Postman from here.
  2. Clone or download this repository to your local machine.
  3. Open Postman.
  4. Click on the "Import" button in the top left corner.
  5. Select "Import From File" and choose the downloaded JSON file (search-api.postman_collection.json).
  6. The collection will be imported into Postman. You can now explore and test the API endpoints.