apache / amoro

Apache Amoro (incubating) is a Lakehouse management system built on open data lake formats.
https://amoro.apache.org/
Apache License 2.0
874 stars 290 forks source link

[AMORO-3256] Amoro Open Api with Swagger in Ams #3296

Open mansonliwh opened 4 weeks ago

mansonliwh commented 4 weeks ago

Why are the changes needed?

Close #3256.

Brief change log

This PR introduces Swagger and OpenAPI Generator. To avoid intrusive development, this design does not use a large number of annotations on the controller. Instead, it predefines the openapi.yaml. The interface specifications defined in openapi.yaml are used to generate the Swagger page, API docs, and an SDK using the Apache HttpClient framework.

In the Maven build, you can use the generate-sdk profile to specify whether to generate the SDK.

How was this patch tested?

Swagger Page: image

Auth Setting: image

Generated API docs & SDK demo: image

codecov-commenter commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 22.54%. Comparing base (f13f3f3) to head (815c0b8). Report is 4 commits behind head on master.

:exclamation: There is a different number of reports uploaded between BASE (f13f3f3) and HEAD (815c0b8). Click for more details.

HEAD has 1 upload less than BASE | Flag | BASE (f13f3f3) | HEAD (815c0b8) | |------|------|------| |core|1|0|
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3296 +/- ## ============================================ - Coverage 30.17% 22.54% -7.63% + Complexity 3840 2312 -1528 ============================================ Files 580 397 -183 Lines 48020 38201 -9819 Branches 6207 5437 -770 ============================================ - Hits 14488 8611 -5877 + Misses 32542 28863 -3679 + Partials 990 727 -263 ``` | [Flag](https://app.codecov.io/gh/apache/amoro/pull/3296/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | | |---|---|---| | [core](https://app.codecov.io/gh/apache/amoro/pull/3296/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | | | [trino](https://app.codecov.io/gh/apache/amoro/pull/3296/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `22.54% <ø> (?)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.