Search Courses Endpoint with Pagination and Fuzzy Search

[ashayp22]

Goals

We want to build an endpoint that allows a user to join a course as a learner. This endpoint can be GET learner/search, with search, page, and size query parameters. The course data can be sorted in ascending alphabetical order based on the course name.

Steps

1. Build an endpoint that returns all courses that a user can join based on a search value, page number, and page size. The endpoint should return all of the information about a course that is found in MongoDB, except the admin_id and approved fields.
2. The endpoint should implement pagination and fuzzy search. You may have to build a MongoDB Aggregation Pipeline.

Don't forget to:

• Make sure to add the appropriate middleware for checking if the client requesting this endpoint can access the courses.
• Write Jest Unit Tests!!! I would test a couple of the scenarios listed in the Example API Calls with our Mock Database.

Example API Calls

Let's suppose that the courses are:

1. English
2. Spanish
3. French
4. German
5. Hindi

GET learner/search?search='' returns English, French, German, Hindi, Spanish
GET learner/search?page=1&size=2 returns English, French
GET learner/search?search=''&page=2&size=3 returns German, Hindi
GET learner/search?search='E' returns English

Notice how the page is 1-based and size courses aren't always returned.

Resources

• Take a look at the Mongoose documentation for more clarification.
• Express docs
• More on Fuzzy Search
• Nice MongoDB method for pagination
• What is Pagination