Hi all,
I create an issue[1] to unify API specifications, because of with the
increase of interfaces, non-standardized api interface can cause some
problems,so we need to unify the api specification in the project early.

Background:

The streampark project interface definition has the following problems:

   1. Api specification not following the RESTful API regulation [2] and
   difficult to maintain with the increase of interfaces
   2. Lack of the api interface description [3]
   3. Some interfaces have redundant parameters [4]
   4. Poor readability

Proposal:

To perfect the swagger interface description and unify api specifications,
improve readability and performance.

Task List:

   1. Perfect the swagger interface description.
   2. Define the interface specification, sorting the api interface that
   needs to be adjusted, before and after.
   3. Unified the api interface specifications and reduce redundant
   parameters.


If you have any suggestions, welcome to participate in the discussion on
the mail or issue. I look forward to your feedback.

[1] https://github.com/apache/incubator-streampark/issues/1796

[2]
https://github.com/apache/incubator-streampark/blob/dev/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/controller/AlertController.java#L85

[3]
https://github.com/apache/incubator-streampark/blob/dev/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/controller/ApplicationController.java#L72

[4]
https://github.com/apache/incubator-streampark/blob/dev/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/controller/AlertController.java#L86


Best,

Shaokang Lv

Reply via email to