Skip to content
GitLab

[Go] Interface definitions for api functions

Merged Administrator requested to merge github/fork/arvindth/ath-add-interfaces into master

Created by: arvindth

  • Add golang interface definitions for api functions
  • Add new go generator option generateInterfaces, defaulted to false.
  • Slight updates to method comments in api.mustache to prettify and align better.
  • Update go-petstore, go-petstore-withXml, and openapi3-go-petstore samples.
  • Verified that the following pass:
    • mvn clean install
    • mvn -Pstatic-analysis clean install
    • mvn integration-test -rf :GoPetstore in samples/client/petstore/go, both for the default go-petstore sample generation, and when generated with generateInterfaces=true.

Questions I had:

  • I see that go-petstore-withXml has withGoCodegenComment=true as an additional option, so it looked like that might be where alternate options were being tested, so I've added generateInterfaces=true to those samples. Let me know if that should get reverted.
  • It looks like the mustache template for the go-experimental generator differs fairly significantly from the go generator, and it's not clear if I should also update go-experimental templates/samples as well.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc go technical committee: @antihax @bvwells @grokify @kemokemo @bkabrda