Create REST Specification for Shopping Cart Service: Cart Management - Githubissues

sokimaaa / 6Core

1 stars 0 forks source link

Create REST Specification for Shopping Cart Service: Cart Management #49

Closed sokimaaa closed 3 months ago

sokimaaa commented 3 months ago

Context

We need to provide the specification (or contract) by which users can interact with the Shopping Cart Service.
In Java terms, we need only Interfaces and Dtos in the scope of this task.
Provide a contract for full cleaning of shopping cart, single cleaning of shopping cart, and partial cleaning of shopping cart
Provide a contract for putting a new item to shopping cart

Acceptance Criteria

The spec submodule is added
Defined the Request, Response objects
Defined the Interface for interacting with the Shopping Cart Service
Well-documented specification with JavaDoc and OpenApi
Ability to extend the contract in the future without impacting clients (versioning)

Technical Details

Explore versioning of REST API
Explore what is Specification Driven Development
Explore what is Api First Approach
Explore springdoc-openapi-starter-webflux-ui and springdoc-openapi-starter-webmvc-ui
Remember about SOLID (Interface Segregation Principle)