Springdoc-openapi: Migration guide from SpringFox

[Aloren]

I've noticed that a lot of existing users are migrating from springfox project to springdoc.
I suppose it would be awesome to have some short migration guide (something simple as this one for example: https://joel-costigliola.github.io/assertj/assertj-core-migrating-from-fest.html). I would like to contribute it if you don't mind. @springdoc What do you think?

[springdoc]

Hi @Aloren,

Please feel free to contribute to documentation and any relevant pages:

FYI main used pages are:

• https://github.com/springdoc/springdoc.github.io/blob/master/src/docs/asciidoc/index.adoc
  
  
  
  • https://github.com/springdoc/springdoc.github.io/blob/master/src/docs/asciidoc/faq.adoc
  
  

[Aloren]

@springdoc Thanks for pointing to the documentation links. I haven't found these from the beginning :) as they are not referenced in https://github.com/springdoc/springdoc-openapi/blob/master/README.md. I just got that they are published to https://springdoc.github.io/, but I suppose it would be better to make a bold link to the https://springdoc.github.io/, so that it is obvious that detailed docs are available there (as it is done here: https://github.com/testcontainers/testcontainers-java/blob/master/README.md)

What do you think?

[Marx2]

I agree that such a guide would be very good idea. I'm currently migrating about 30 microservices from springfox to springdoc.
As for now I've managed to:

• replace @ApiParam with @Parameter
• migrate oauth configuration
• refactor @ApiResponses
• reuse Spring Pageable support - I've just found nice workaround https://github.com/springdoc/springdoc-openapi/issues/251

[cmalla94]

On this topic, I have a somewhat working bash script that doe migration for refactoring of annotations and imports. Let me know if this something that would useful to be part of the migration documentation. repo

[bnasslahsen]

Hi @Aloren,

This is a good idea! Please feel free to propose any relevant information to improve the documentation of the library.

[Aloren]

Initial version added here: https://github.com/springdoc/springdoc-openapi-demos/pull/8

[bnasslahsen]

Thank you @Aloren for this very useful documentation, which will certainly be enhanced with other contribution.
The main site has been updated. It contains a direct link to the migration guide you have initiated:

• https://springdoc.org/index.html#migrating-from-springfox

[Mastcard]

Updated URL : https://springdoc.org/migrating-from-springfox.html

[huseyinmobil]

We create a tool (MobilizIT/springfox-tospringdoc) according to https://springdoc.org/migrating-from-springfox.html It is not complete yet but works for most cases