Required Project Dependencies

• Go

  • ogen requires Go v1.18+

• Task

  • Like Makefiles but made easier and for Go projects!

• GoFmt

  • Opinionated go formatter

• Bun

  • Fast Typescript/Javascript runtime.
  • Used along with fluid-oas for generated OpenApiV3 specifications.

Typical development workflow:

1. Make changes in api, generate the openapi specification by using task api:generate

2. Regenerate handler layer in backend by using task challenge:generate

3. Implement handlers, business logic, etc.

Helpful commands:

You can grab all existing commands

task --list-all

Generate OpenApi Spec

# Generate openapi specification
task api:generate
# Generate server code from openapi specification
task challenge:generate

# Run the server locally (Not in docker)
task challenge:run

# Run all tests including integration tests (Might take a while)
task challenge:test