javalin / javalin/javalin-openapi

Generate default documentation for registered routes

Open
#49 2 comments 4 reactions 0 assignees View on GitHub
enhancement scope: runtime
Dominant language
Kotlin
Stars
67
Forks
24
PR merge metrics
No merged PRs in 30d

Description

The old plugin had support for default responses:

```
OpenApiOptions().apply {
defaultDocumentation { doc ->
doc.json("500", ErrorResponse::class.java)
doc.json("503", ErrorResponse::class.java)
}
}
```

These are responses which could occur on any endpoint.

Contributor guide

Open the contributing guide

Research direction

Start by finding where registered routes are converted into OpenAPI documentation and how responses are represented. Use the old plugin example as the behavioral reference; done means configured default responses such as 500 and 503 appear on every endpoint without requiring per-route declarations.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.