Little Shop BE Extensions
Extensions & Extra Practice
External API Consumption
Get Item Images
Details:
- The endpoint should be in the pattern of
GET /api/v1/items/:id, to add onto the “Fetch a Single Record” endpoint (#2 above). - You will need to utilize the Unsplash API for this - specifically, the Search Photos endpoint. Supply a query that would work for this item’s name, and use the API to retrieve an image to represent this item.
- If an invalid image id is passed in, a 404 status as well as a descriptive error message should be sent back in the response.
- The
datatop level key should always point to an array even if one or zero images were found for this image. - If no image is found, a link to a placeholder image URL can be used (see placehold.co), using the
Textoption to include a URL-encoded string representing the Item’s name in the placeholder image.
Example 1 😁
Request:
GET /api/v1/item/1
Content-Type: application/json
Accept: application/json
Response:
status: 200
{
"data": {
"id": "1",
"type": "item",
"attributes": {
"name": "Super Widget",
"description": "A most excellent widget of the finest crafting",
"unit_price": 109.99,
"image_url": "https://api.unsplash.com/photos/eOLpJytrbsQ" //or, https://placehold.co/600x400?text=Super+Widget
}
}
}
Example 2 😭
Request:
GET /api/v1/item/123123123123 (where this is an invalid ID)
Content-Type: application/json
Accept: application/json
Response:
status: 404
{
"errors": [
{
"detail": "Couldn't find Item with 'id'=123123123123"
}
]
}
Get Merchant Images
Details:
- The endpoint should be in the pattern of
GET /api/v1/merchants/:id, to add onto the “Fetch a Single Record” endpoint (#2 above). - You will need to utilize the Unsplash API for this - specifically, the Search Photos endpoint. Supply a query that would work for this merchant’s name, and use the API to retrieve an image to represent this merchant.
- If an invalid image id is passed in, a 404 status as well as a descriptive error message should be sent back in the response.
- The
datatop level key should always point to an array even if one or zero images were found for this image. - If no image is found, a link to a placeholder image URL can be used (see placehold.co), using the
Textoption to include a URL-encoded string representing the merchant’s name in the placeholder image.
Example 1 😁
**Request:**
```
GET /api/v1/merchant/1
Content-Type: application/json
Accept: application/json
```
**Response:**
`status: 200`
```json {
"data": [
{
"id": "1",
"type": "merchant",
"attributes": {
"name": "Mike's Awesome Store",
"image_url": "https://api.unsplash.com/photos/eOLpJytrbsQ" //or, https://placehold.co/600x400?text=Mike%27s\nAwesome\nStore
}
}
]
},
```
Example 2 😭
**Request:**
```
GET /api/v1/merchant/123123123123 (where this is an invalid ID)
Content-Type: application/json
Accept: application/json
```
**Response:**
`status: 404`
```json
{
"errors": [
{
"detail": "Couldn't find merchant with 'id'=123123123123"
}
]
}
```
</details>
