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

Moved to Swagger 2 annotations as well as SpringDoc instead of Springfox #4779

Closed
wants to merge 5 commits into from

Conversation

N4zroth
Copy link

@N4zroth N4zroth commented Dec 12, 2019

Changed the generated annotations to Swagger 2 annotations, built the samples and verified them by hand (and maven clean compile). The only thing I can't get to work is the @Schema in springboot-reactive as it results in class=List.class which is obviously incorrect. The other projects compile and seem to be correct. Would love to be corrected if need be, though :)
The underlying issue was #4245

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.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)

@wing328
Copy link
Member

wing328 commented Jan 2, 2020

@N4zroth thanks for the PR. Please PM me via Slack to discuss this PR when you've time.

@alexsuperdev
Copy link
Contributor

@N4zroth its realy important issue i think. Can you fix the conflicts or do you need help with it? I would like to have restdocs in the next releases of openapi-generator.

@cbornet
Copy link
Member

cbornet commented Feb 14, 2020

I think Springfox is still far more used than Springdoc. So using v3 annotations should be an option atm.

@alexsuperdev
Copy link
Contributor

I think Springfox is still far more used than Springdoc. So using v3 annotations should be an option atm.

Yes, you are right. But the thing is springfox latest release was in June 2018. They don't support OpenApi 3. Yes, best case would be an option to choose between both of them.

Fabian Günter and others added 2 commits April 2, 2020 09:58
@shred22
Copy link

shred22 commented Apr 23, 2020

Any tentative timelines when this PR will be merged?

@tan9
Copy link

tan9 commented Apr 30, 2020

It will be awesome if this MR can be included in the 5.0.0 milestone.

@cbornet
Copy link
Member

cbornet commented Aug 2, 2020

Springfox v3 has been released and it supports OASv3. So we should stick with Springfox as it's much more popular and upgrade it to v3.

@matnice
Copy link

matnice commented Aug 9, 2020

@cbornet,

Can we please have the support of springdoc as well for OAS 3 ?

springfox is not popular for OpenAPI3. Springfox lacks of maintenance. The last release was more than two years ago.
The springfox new release 3.0.0 is already plenty of issues and missing a lot of fuctionnalities. You can just have a tour on the github:

All projects since this date who needed OpenAPI 3 support in spring applications moved to springdoc.

We really need this enhancement, and thank you for the support of springdoc as well.

@mstroecker
Copy link

Is there any hope?

@honza-zidek
Copy link

Is there any progress please? It has been open for so long...

@RockyMM
Copy link
Contributor

RockyMM commented Nov 7, 2021

I am interested in this issue as well. If there is nobody else, I hope around Christmas time I could invest some time into fixing merge conflicts.

@uniquejava
Copy link

Springfox is abandoned , 3.0 is their last release and yet another year passed, please use springdoc.

@welshm
Copy link
Contributor

welshm commented Dec 10, 2021

FWIW - this may be a solution for those looking to use oas3 and springdoc

#9775

@cachescrubber
Copy link
Contributor

@N4zroth, @wing328 since 5.4.0 springdoc is the default documentation provider for the spring generator. Please close this PR.

@wing328 wing328 closed this Aug 10, 2023
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.