continuous-poker / dealer

Apache License 2.0
7 stars 3 forks source link

Feat/improve dealer api #107

Closed ds-apena closed 8 months ago

ds-apena commented 8 months ago

The purpose of this feature branch is to enable workshop participants the access to a high-quality, well-documented API for interacting with the dealer. The project includes now an OpenAPI descriptor file that contains information about each endpoint, including a method description, an overview of the expected parameters and the HTTP responses generated by each of them. The functionality of every API endpoint was checked carefully during the development of this feature e.g through manual tests contained in a curated insomnia collection and also through automated test methods, making use of the Rest Assured library and Quarkus test annotations. Additionally, closely-related endpoints were grouped in order to improve the user experience while using the API.