Draft
Add Javalin OpenAPI documentation to all API endpoints#1890
Conversation
Copilot
AI
changed the title
[WIP] Document endpoints for JavalinWebContainer excluding JavalinWebContainer
Add Javalin OpenAPI documentation to all API endpoints
Jul 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Integrates the
javalin-openapicompile-time annotation processor to generate a live OpenAPI 3.1 spec and Swagger UI for all REST endpoints, based on the existing API documentation at https://peerbanhelper.apifox.cn/llms.txt.Dependencies (
build.gradle.kts)io.javalin.community.openapi:openapi-annotation-processor:7.2.2— annotation processorio.javalin.community.openapi:javalin-openapi-plugin:7.2.2— spec served at/api/openapiio.javalin.community.openapi:javalin-swagger-plugin:7.2.2— Swagger UI at/swaggerPlugin registration (
JavalinWebContainer.java)Endpoint annotations (~31 files)
@OpenApiadded to every handler method across:AutoRangeBan,IPBlackList,ClientNameBlacklist,PeerIdBlacklist,ProgressCheatBlocker,MultiDialingBlocker,ExpressionRuleSwarmTrackingModuleEach annotation documents path, HTTP method, Chinese summary/tags matching the apifox spec, path/query params, request body, and standard responses (200/400/403/500).
Total coverage: 123 operations, 102 paths, 29 tags.
Original prompt