Search code examples
restasynchronousswaggerraml

Does Swagger/RAML (or any similar REST API spec) supports REST asynchronous client callbacks?

I want to use REST async client callback, meaning the server is causing a callback operation to be invoked on the client side when a response is ready (see Jersey's 'Asynchronous Services and Clients' to get what I mean)

Can I express this in Swagger/RAML/anything similar, and enjoy the relevant server/client code generation, documentation generation etc.? Can you point to relevant examples/resources?

Solution

  • OAS (formerly Swagger) considered it:
    https://github.com/OAI/OpenAPI-Specification/issues/716
    https://github.com/OAI/OpenAPI-Specification/issues/737
    and even merged the callback feature and landed in OAS 3.0.
    But the tools I used doesn't seems to support the addition at the moment.