UVicMartletplace / martletplace

Recreating FB Marketplace for Students - UVic SENG499 Capstone Project
0 stars 0 forks source link

Gavin/115 create api endpoint stubs for recommender #117

Closed GDeane closed 3 months ago

GDeane commented 3 months ago

Description

This PR includes the stub methods/endpoints to implement for the recommender API.

Additionally, it includes some definitions of BaseModel classes which help to clearly define the allowed inputs and (successful response) outputs.

Closes #115

How to Test

  1. Run 'docker-compose up --build' in the root of the martletplace repo.

  2. Enter the following into your browser: http://localhost:8222/api/recommendations?authorization=spaghetti&page=1&limit=20

    • Your output should look like this: image
  3. Enter the following into your browser: http://localhost:8222/docs

    • The page should look like this: image
  4. For each endpoint shown, click 'try it out', fill out the parameter fields, and execute. Check the outputs.

Checklist