Extending - support MQTT - question

Is it reasonable to write an extension that supports MQTT protocol in API definition?

It's required for IoT project, where both HTTP Rest and MQTT are primary protocols.

I need to generate nice looking documentation with SUBSCRIBE, PUBLISH etc, topic names, patters, json schemas. Looking similar to swagger generated documentation for REST services?

Does it even make sense?

[cbornet]

MQTT being a PUBLISH/SUBSCRIBE protocol, I don't think it fits well to an "API" description which describes a REQUEST/RESPONSE protocol.
In the IoT world, I think you could describe a CoAP API with OpenAPI.

[casualjim]

None the less publish subscribe is a very valid thing also for server sent events, websockets etc. imo OAI should support more than just request/response message flows because http already does more.

Something like this might work for it
#396

Generating documention works and looks good if I just replace GET/POST with PUBLISH/SUBSCRIBE , just gives some warnings.

It's probably not the way to go..

[lieldulev]

👍

I do think this issue is the same as #55 and #396.

[fehguy]

Parent issue #586

[gioppoluca]

+1 on this, is there anyone working on this?

[fehguy]

@gioppoluca I do not expect this will be part of 3.0, but it is in the list for future versions.

[akauppi]

Valid question and answers, got links, work ongoing in other issues. Can this one be closed?

[fmvilas]

@piotrmach you might be interested in the AsyncAPI specification: asyncapi.com. It's intended for the purpose you mentioned.

[xdvarpunen]

@fmvilas Asyncapi looks promising.

[fmvilas]

Thanks @xdvarpunen. We'll be launching version 2 soon. Stay tuned!

[AtosNicoS]

Is there any progress in this issue? Maybe the asyncapi project/ideas can be integrated into the openapi spec?