Create REST Specification for Warehouse Service: Inventory Exploration - Githubissues

sokimaaa / 6Core

1 stars 0 forks source link

Create REST Specification for Warehouse Service: Inventory Exploration #25

Closed sokimaaa closed 3 months ago

sokimaaa commented 4 months ago

Context

We need to provide the specification (or contract) by which users can interact with Warehouse Service.
In Java terms, we need only Interfaces and Dtos in the scope of this task.
Provide a contract for exploring the inventory, e.g. when the merchant is going to check the status of his inventory (Full, empty, product quantity, and so on).
For now, we don't need any filtering, sorting, paging

Acceptance Criteria

The spec submodule is added
Defined the Request, Response objects
Defined the Interface for interacting with the Warehouse 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)