[rest] Introduce Redoc to visualize Rest API#5336
Merged
JingsongLi merged 1 commit intoapache:masterfrom Mar 25, 2025
Merged
Conversation
JingsongLi
reviewed
Mar 25, 2025
| specific language governing permissions and limitations | ||
| under the License. | ||
| */}} | ||
| <body> |
Contributor
There was a problem hiding this comment.
Can this page be a separate page?
Contributor
There was a problem hiding this comment.
It looks like it is not so good in hugo framework.
Contributor
There was a problem hiding this comment.
I found the way, I will fix it after merging this PR.
Contributor
Author
There was a problem hiding this comment.
Wise consideration! it is really better to be in a separate page, thanks :)
Contributor
|
Thanks @liyubin117 , Looks good to me! |
danzhewuju
pushed a commit
to danzhewuju/paimon
that referenced
this pull request
Mar 31, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Currently, it is difficult to understand the RestCatalog API in text form (https://raw.githubusercontent.com/apache/paimon/master/paimon-open-api/rest-catalog-open-api.yaml).
We can introduce Redoc (refer to https://nordicapis.com/using-redoc-to-auto-generate-openapi-documentation/) to visualize how the API can be used as shown below. And it will automatically change with the changes of the YAML definition, without additional maintenance.
Tests
API and Format
Documentation