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.

Sign up for GitHub

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

Jump to bottom

Announcement: 3.0.0 Release #3386

Closed
dilipkrish opened this issue Jul 14, 2020 · 19 comments
Closed

Announcement: 3.0.0 Release #3386

dilipkrish opened this issue Jul 14, 2020 · 19 comments
Labels
Announcement
Milestone
3.0

Comments

@dilipkrish
Copy link
Member

Release Notes

image
Picture Credit National Geographic

First and foremost a big thank you to the community for keeping me motivated to work on this project. There have been some really amazing contributions in this release in terms of code, comments, bug reports and it is humbling to see people jumping in to solve problems on the issue forum. It sure motivated me to get over the "hump" and start working on in earnest. What better way to lose the COVID blues!

Thank you! 🥳 🍾

Also please welcome the newest maintainer to the springfox team @MaksimOrlov. A lot of the great work you see in the model generation support is due to his efforts, collaborating tirelessly on weekends and not giving up while ensuring the model generation engine is performant 👏

NOTE: This is a breaking change release, I've tried to maintain backwards compatibility with earlier versions of springfox as much as possible. Deprecated APIs prior to 2.9 have been aggressively removed and new APIs that will go away in the near future have been marked. So please look out for those and do report anything that has been missed.

Highlights of this release include

  • Spring 5, Webflux support (only request mapping support, functional endpoints aren't supported yet)
  • Spring Integration support (feedback is much appreciated)
  • Spring Boot support springfox-boot-starter dependency (Zero Config, Autoconfiguration support)
  • Documented Configuration Properties with autocomplete
  • Better specification compatibility with 2.0
  • Support for OpenApi 3.0.3
  • Zero Dependency (almost, the only libraries needed are spring-plugin, pswagger-core](https://github.com/swagger-api/swagger-core)
  • Existing swagger2 annotations will continue to work and enrich open api 3.0 specification

Contributions

Significant contributions that come to mind (and please remind me of others in this list cos' my memory is weak)

  • @MaksimOrlov for his work on better model generation (json view, validation groups, request/response models)
  • @dschulten for introducing spring integration support
  • @deblockt and @ligasgr for their work on webflux support
  • @ile for spring 5 support
  • @neil1hart for removing the guava dependencies
  • and @cbornet for the occasional nudges to working on this release :)

Pull Requests

Bug Fixes

Maintenance

Features
@dilipkrish dilipkrish added this to the 3.0 milestone Jul 14, 2020
@dilipkrish dilipkrish pinned this issue Jul 14, 2020
@dilipkrish
Copy link
Member Author

This should be available in maven central soon

@atkawa7
Copy link

atkawa7 commented Jul 14, 2020

Thank you @dilipkrish and all other contributors for your work in pushing this out. Thank you

@vnobo
Copy link

vnobo commented Jul 14, 2020

Thank you

@ligasgr
Copy link
Contributor

ligasgr commented Jul 14, 2020

Thanks a lot for this great effort!

@ayounsi
Copy link

ayounsi commented Jul 15, 2020

Thank you all for the work done.

@derTobsch
Copy link

It is here and I updated our application :) Thanks @dilipkrish

@krishnaiahthota
Copy link

@dilipkrish Thanks for the effort. could you please share any example with spring boot to feel the Open Api spec

@dilipkrish
Copy link
Member Author

@krishnaiahthota Couple of useful places to get started

  • Please read the docs
  • There is the demos project to demonstrates different flavors of apps and how it works with the latest version of springfox

@Toerktumlare
Copy link

amazing work! all you guys are the best!

@nzall
Copy link

nzall commented Aug 7, 2020

@dilipkrish So to be clear: this still supports Spring projects that aren't yet Spring Boot; and it is tested with JDK 11?

@dilipkrish
Copy link
Member Author

Yes, it should still support projects and it is tested with java 11. Have a look at the demos there are different flavors of spring projects listed

@norepeat
Copy link

hi @dilipkrish , for #2676, it works for @ApiResponse,but still not working for @ApiImplicitParam, like below sample:
@ApiImplicitParams({
@ApiImplicitParam(
name = "contents",
dataType = "CustomTypeFor2031",
examples = @io.swagger.annotations.Example(
value = {
@ExampleProperty(value = "{'property': 'test'}", mediaType = "application/json")
})) //<1>
})

@norepeat
Copy link

sorry, the refer issue should be #2767 , not 2676

@winson08Li
Copy link

hi @dilipkrish, I comfirmed the example not render issue is fixed for @ApiResponse, but not for @ApiImplicitParam, just like @norepeat mentioned.

@fzyzcjy
Copy link

fzyzcjy commented Jan 31, 2022

Hi I wonder whether this lib is deprecated? It does not have commits for a long time ... :(

@alienisty
Copy link

Yes it looks like the fox it's dead. I had to fork it to fix it for spring boot 2.6+ until we find an alternative.

@ogerardin
Copy link
Contributor

Yes it looks like the fox it's dead. I had to fork it to fix it for spring boot 2.6+ until we find an alternative.

I believe the alternative is https://springdoc.org/
So long springfox, it was good while it lasted.

@Toerktumlare
Copy link

An official statement from @dilipkrish would be nice, or a hand over to someone else, or if someone wants to make a new official fork.

the repo should be put in maintnance mode

@nzall
Copy link

nzall commented Jan 31, 2022

Yes it looks like the fox it's dead. I had to fork it to fix it for spring boot 2.6+ until we find an alternative.

I believe the alternative is https://springdoc.org/ So long springfox, it was good while it lasted.

The challenge with springdoc is that AFAIK, it requires Spring Boot, so if your project predates Spring Boot and you've been using default Spring since forever, you're also looking at a requirement to integrate Spring Boot, which may be a complex endeavor if, like our product, you're using Spring for your REST API while using a different framework like Struts for your GUI. Admittedly we haven't looked into how complex this would be, but we assume it's not trivial to keep everything working the same.

@Gnu-Kenny Gnu-Kenny mentioned this issue Mar 30, 2022
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Announcement
Projects
None yet
Milestone
3.0
Development

No branches or pull requests