2024-11-26 01:22:45 +00:00
|
|
|
# STRAFES.NET API
|
|
|
|
|
|
|
|
## How to Begin Development
|
|
|
|
|
|
|
|
1. Run `go generate` to ensure the generated API is up-to-date. This project uses [ogen](https://github.com/ogen-go/ogen).
|
|
|
|
```bash
|
|
|
|
go generate -run "go run github.com/ogen-go/ogen/cmd/ogen@latest --target api --clean openapi.yaml"
|
|
|
|
```
|
|
|
|
2. Build the project.
|
|
|
|
```bash
|
2024-11-26 22:03:18 +00:00
|
|
|
go build git.itzana.me/strafesnet/maps-service
|
2024-11-26 01:22:45 +00:00
|
|
|
```
|
|
|
|
|
2024-11-26 22:03:18 +00:00
|
|
|
By default, the project opens at `localhost:8080`.
|
2024-12-04 03:13:29 +00:00
|
|
|
|
|
|
|
## How to generate rust api from this directory
|
|
|
|
```bash
|
|
|
|
openapi-generator-cli generate -g rust -i openapi.yaml -o validation/api`
|
|
|
|
```
|
2024-12-10 02:16:03 +00:00
|
|
|
|
|
|
|
#### License
|
|
|
|
|
|
|
|
<sup>
|
|
|
|
Licensed under <a href="LICENSE">MIT license</a>.
|
|
|
|
</sup>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
<sub>
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
|
|
for inclusion in this project by you, shall be licensed as above, without any
|
|
|
|
additional terms or conditions.
|
|
|
|
</sub>
|