websocket-doc-ui is a documentation tool for WebSocket APIs that runs exclusively on Spring Boot projects.
It was created to address the lack of open-source solutions for documenting WebSocket endpoints.
This library helps you easily document and manage your WebSocket APIs, improving development productivity and collaboration.
- Automatic WebSocket API documentation for Spring Boot applications
- Intuitive UI for easy exploration of WebSocket endpoints
- Extensible architecture to support custom features
For detailed integration instructions, including Gradle dependency and component scanning setup, please see the Developer Guide.
For contribution guidelines, issue reporting, and pull request process, please refer to the Developer Guide.
Thank you for contributing!
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
- Email: [email protected]
- GitHub: mini0192