Swagger / Redoc documentation

[SylvainCorlay]

Hello, uwebsockets looks like a perfect fit for a project where I need to process lots of websockets messages efficiently. Thanks for the amazing work!

On the rest endpoints side, is there any example out there of people generating and hosting swagger or redoc documentation for a uwebsockets-based API?

[ghost]

I know even less about that than you do. I have no idea - probably not?

[SylvainCorlay]

Thank you for your reply!

I don't know how we could achieve something like this, but it would be a really compelling selling point for uwebsockets. (I am personally convinced already).

[ghost]

I don't even know exactly what swagger is? You generate code with it? And documentation?

That probably works for hugely popular things with very little requirements variation - simple repetitive things?

But it still kind of sounds like doing the same work only in different ways?

[SylvainCorlay]

Sorry for the late reply. Swagger is a tool to document REST APIS, and provides a UI to interact with a running server. You can check out e.g. https://petstore.swagger.io/.

For some frameworks like FastAPI, the swagger JSON file is automatically generated from the signatures of the endpoints.

[ghost]

What I can see there would have to be alone kind of interoperability with "OpenAPI Specification"?

That could probably be implemented as an abstraction around the uWS::App without touching anything internal

[ghost]

Like SwaggerApp inheriting from uWS::App

[SylvainCorlay]

The real deal would be to generate them somewhat automatically.

[ghost]

Well yes but you have to implement this somewhere and it doesn't belong with anything internal. It's an abstraction eating/consuming this specification.

[brunoqs]

Hello im using this lib to generate openapi.json https://www.npmjs.com/package/swagger-jsdoc?activeTab=readme. But the i want to create swagger routes also