Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[go-server] Return Router interface from controller constructor. #4196

Merged

Conversation

Jesse0Michael
Copy link
Contributor

@Jesse0Michael Jesse0Michael commented Oct 21, 2019

Update the go server api controller template to return the Router interface instead of the api specific router.
The Router interface type has the Routes function, which is what the generated NewRouter function needs. (not the api specific interface).

The change added in #4038 would cause the following error since it was working with the wrong interface type

./main.go:38:36: cannot use PetApiController (type petstoreserver.PetApiRouter) as type petstoreserver.Router in argument to petstoreserver.NewRouter:
        petstoreserver.PetApiRouter does not implement petstoreserver.Router (missing Routes method)

@antihax @bvwells @grokify @kemokemo @bkabrda

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.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

Update the go server api controller template to return the Router interface instead of the api specific router.
The Router interface type has the Routes function, which is what the generated `NewRouter` function needs. (not the api specific interface).
@auto-labeler
Copy link

auto-labeler bot commented Oct 21, 2019

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@wing328 wing328 added this to the 4.2.0 milestone Oct 22, 2019
@wing328 wing328 merged commit 00c6e0a into OpenAPITools:master Oct 22, 2019
@Jesse0Michael Jesse0Michael deleted the go-server-return-router-interface branch October 22, 2019 17:34
@wing328
Copy link
Member

wing328 commented Oct 31, 2019

@Jesse0Michael thanks for the PR, which has been included in v4.2.0 release: https://twitter.com/oas_generator/status/1189824932345069569

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants