Add support for API documentation #2082
Conversation
f2c-ci-robot
bot
added
release-note-none
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: guqing The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
f2c-ci-robot
bot
added
the
approved
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: guqing The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind feature
What this PR does / why we need it:
Add support for API documentation using springdoc v2.
Because we are using Spring Boot 3, springdoc v2 have to be used for our API documentation.
You could learn more about Jakarta support of Springdoc from springdoc/springdoc-openapi#1284.
After started, you can browse
http://localhost:8090/swagger-ui.htmlto acess API documentation.Why don't we use SpringFox?
The main reason why we don't use it is lack of maintenance. We are using Spring Boot 3 and minimal JDK is 17, SpringFox is incompatible with them.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
/cc @halo-dev/sig-halo
Does this PR introduce a user-facing change?