WIP Golang implementation of https://github.com/defenseunicorns-partnerships/wfapi
This is an API-FIRST project, meaning that the OpenAPI specification file is the source of truth. The codebase is generated/written based on the OpenAPI specification file.
- Docker
- Docker Compose (probably already installed with Docker)
- UDS CLI
Since this is an API-FIRST project, we edit the OpenAPI specification file before we make code changes. You can edit the OpenAPI Specification file however you want, as long as it stays compatible with the OpenAPI 3.0.2 specification and is editable in the OpenAPI Studio:
- Run
uds run studio:up - Open the OpenAPI Studio in your browser by navigating to http://localhost:8888
- Drag
openapi-spec.yamlinto the browser window - Edit the OpenAPI Specification file
- Click Save As -> YAML
- Save the file as
openapi-spec.yamlin the root of the project. Overwrite the existing file. - Commit the changes
- When you're done, run
uds run studio:downto clean up