feat: Add Swagger for building REST API documentation

[ittuann]

In a recent discussion #2613, I found that one of the needs is looking for tools or methods that can be used across multiple programming languages (Java, Python, Go). I considered using Swagger to build REST API documentation.

Swagger (OpenAPI) is a language-agnostic specification, which means it is not limited to any specific programming language.

Swagger is used to describe REST APIs and provides a standardized way to detail an API, including paths, operations, input parameters, output responses, and more.

Not only does Swagger facilitate developers' understanding of the API's functionality, it also allows for real-time testing on web pages. Official examples can be viewed here: Swagger PetStore https://petstore.swagger.io/

I think it's suitable for the current scene. I created a sample StreamPipes demo using Swagger to show the effect:

The content in this demo is not yet comprehensive and may contain some errors; it is merely to showcase the general effect and potential value of building with Swagger.

Beyond the cross-language capabilities, I believe that introducing Swagger documentation could greatly facilitate user integration of StreamPipes in unsupported languages, such as Rust.

If this feature is approved, I would also be willing to commit the current results to the project.

[bossenti]

Hey @ittuann,

Thank you very much for your proposal!
We already have swagger documents available for StreamPipes. You can access them via the link at the bottom of the login screen.

Frankly, not all of our REST endpoints are document properly yet, but the most important ones should be. In case you want to polish some endpoints to that extend, PRs are always welcome 🙂