Repository files navigation

The gin templates that are available in theexisting openapi generatorrequire in place modification. This does not suit our workflow. We would like to be able to regenerate our API interfacewithout having to patch in our own code every time. gRPC generates code that illustrates how to generate code that canbe used without modification.

This repository is intended to apply the pattern used by gRPC to Gin for rest services.

Download the latestrelease archive for your platform and extract it.Copy theexample config file to a convenient location and modify it to your needs.

Run the can command as follows:/path/to/can --configFile=/path/to/can.yml

Seedesign.md

• Look into yaml.Readpath
• Look into unmarshalling composed types
• Implement e2e testing of generated code (1.0)
• (Alex) test resolveRefs against nested refs and debug - use hackday branch for reference
• Finish unit testing
• Spec Compliant Templating
  • go-client
  • go-gin+* Pipeline
  • Linting (https://github.com/uber-go/guide/blob/master/.golangci.yml)
  • Automated PR-blocking testing for unit and e2e testing
  • Automated PR-blocking building of binary
  • Release pipeline revision for main

• Unmarshal refs into node container
• Full Open Api spec 3.x coverage
• Make full use of Architechtural Decision Records - keep in main branch
• Robust CI pipeline
• Implement style guide for development - possible adapted from pre-existing industry-used guides