Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable websocket API doc generation #4

Closed
joffrey-bion opened this issue Mar 29, 2017 · 1 comment
Closed

Enable websocket API doc generation #4

joffrey-bion opened this issue Mar 29, 2017 · 1 comment

Comments

@joffrey-bion
Copy link
Owner

joffrey-bion commented Mar 29, 2017

We should find a way to generate a documentation of the websocket API to make it easier to maintain.

Swagger seemed to be an option, but is fundamentally tied to REST, and thus not adequate to use for websockets as-is:
swagger-api/swagger-socket#47
OAI/OpenAPI-Specification#55

JsonDoc looks like a viable option, but we should first have a closer look at how it works.

@joffrey-bion
Copy link
Owner Author

Made obsolete now that the whole project is 100% Kotlin.
Local project dependencies allow to have even better than documentation: code completion and type safety.

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

No branches or pull requests

1 participant