Forum Discussion

LeonardLai's avatar
LeonardLai
Occasional Contributor
6 years ago

May I use swagger to describe websocket?

Hi

 

Is it possible to describe Websocket server api via Swagger?

 

Thanks

  • sjmcdowall's avatar
    sjmcdowall
    New Contributor
    5 years ago

    Any luck with this at all?  I am also trying to document a websocket API .. Cheers!

     

    • HKosova's avatar
      HKosova
      SmartBear Alumni (Retired)
      5 years ago

      Check out AsyncAPI. It's very similar to the OpenAPI (fka Swagger) Specification but designed specifically for event-driven messaging APIs, including WebSocket APIs.

      • sjmcdowall's avatar
        sjmcdowall
        New Contributor
        5 years ago

        Thanks -- that is where I am heading to next!