Open mfw78 opened 11 months ago
We can consider using utoipa
, but this project(https://github.com/ProbablyClem/utoipauto) clearly describes the main drawback of the lib's current state. But looks like this project is not currently ready to work with external types: https://github.com/ProbablyClem/utoipauto/issues/4 meaning that schemas should be specified manually, which is also prone to human errors.
Epic label:
E:3.4 Self-documenting Rest APIs
Planned start date: 01/12/2023 Due date: 31/12/2023Summary
Within the
services
repository, there are two Rest APIs that are exported inopenapi.yml
, notably in theorderbook
and thesolvers
crates.When analysing these Rest APIs, it was identified that:
openapi.yml
that is used by downstream consumers is not programmatically bound / generated via CI/CD, leading to error-prone manual maintenance / updating.solvers
crate makes use ofaxum
/tower
, as opposed to theorderbook
crate that makes use ofwarp
.Acceptance Criteria
On completion of this refactor, the Rest APIs shall:
Tasks