27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
# Backoffice API
|
|
|
|
Backoffice API for my training activities etc. maybe workshops in the future.
|
|
|
|
## API
|
|
|
|
The API is going to be REST with OpenAPI specification and Swagger (or similar) UI for development. In the future this may change and for example gRPC (Connect RPC :eyes:).
|
|
|
|
The API scheme resides in the [`api/`](/api) directory. With major version like [**v0**](/api/v0), **v1**,... being subdirectories.
|
|
|
|
### API and code
|
|
|
|
The code is generated from API schema, not the other way around (schema from code).
|
|
|
|
For this, I am using [oapi-codegen](https://github.com/oapi-codegen/oapi-codegen). The other project considered was [ogen](https://github.com/ogen-go/ogen). This choice may be review in the future.
|
|
|
|
My main concern with **oapi-codegen** is with optional fields, since pointers are used while **ogen** is utilizing Go's generics. Which I feel may be a better fit.
|
|
|
|
### API versioning
|
|
|
|
I want to split major versions (:warning: breaking changes) with folders in code and also in URL path.
|
|
|
|
This is done mainly to gain experience with such approach.
|
|
|
|
The first of API scheme iteration is marked as **v0**, since I expect not to get everything right the first time and I want to try this approach while designing the API. Altho it's just a number and there is no reason between **v0**, **v1**, **v2**,...
|
|
|
|
Current major API version is [v0](/api/v0).
|