Skip to content
This repository has been archived by the owner on Dec 18, 2018. It is now read-only.

Swagger support? #2913

Closed
Kikimora opened this issue Sep 5, 2018 · 3 comments
Closed

Swagger support? #2913

Kikimora opened this issue Sep 5, 2018 · 3 comments

Comments

@Kikimora
Copy link

Kikimora commented Sep 5, 2018

How can I generate swagger documentation for SignalR API?

@analogrelay
Copy link
Contributor

There is no way to do this as OpenAPI does not support RPC-style documentation. OpenAPI and Swagger are only for generating descriptions of REST APIs, but SignalR does not use a REST API, it has a custom protocol.

AsyncAPI is a better fit here, and we're investigating systems like that for describing SignalR APIs in the future.

@analogrelay
Copy link
Contributor

Closing this as the question has been answered. Feel free to comment further if you need clarification on something! We can always re-open the issue if there's something to fix here.

@RicoSuter
Copy link

Swagger/OpenAPI is not really able to describe SignalR hubs, that's why I created an experimental spec + generator: https://github.com/RSuter/SigSpec

Discussion about Swagger + SignalR: RicoSuter/NSwag#691

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants