Sahara云大数据>> redis-product-catalogue-service>> 返回
项目作者： elena-kolevska

项目描述 ：
A simple REST API providing a way to manage and browse products
高级语言： Go
项目地址: git://github.com/elena-kolevska/redis-product-catalogue-service.git


Redis Product Catalogue Service

https://elena-kolevska.github.io/redis-product-catalogue-service

Overview

A simple REST API providing a way to manage and browse products

Context

This project is done as a simple exercise for data modelling with Redis in Go

Logical Data Model

Image

  • Id : Number
  • Value : Binary
  • Product: Product (1)

Product

  • Id : Number
  • Name : String
  • Description: String
  • Vendor : String
  • Price : Number
  • Currency : String
  • MainCategory : Category (1)
  • Images : Image (0..n)

Category

  • Id : Number
  • Name : String
  • Products : Product (0..n)

Physical Data Model

data Model

Documentation

You can find the API documentation here.

It’s written using the OpenAPI 3 specification, with the yaml files living in the docs folder.

To export the documentation to a self-contained, zero-dependencies html file, you can use the ReDoc library. Just run the following command:

redoc-cli bundle docs/index.yaml --output docs/index.html --title "Redis Product Catalogue Service Documentation" --options.theme.colors.primary.main=#D82C20

Configuration

When setting up the program rename the conf_example.json file to conf.json and populate it with your values.

Tests

Execute tests the standard way, by running

  1. go test

TODO

  • Implement authentication
  • More complete pagination
  • Finish tests for the Product model
  • Create a Category Index endpoint