javalin / javalin/javalin-openapi

Use JavaDoc for JSON Schema and @OpenApi summary & description

Open
#270 0 comments 0 reactions 0 assignees View on GitHub
triage
Dominant language
Kotlin
Stars
67
Forks
24
PR merge metrics
No merged PRs in 30d

Description

**Describe the feature**

It would be cool if it would automagically process JavaDoc (with a doclet) and use it for JSON Schema and OpenAPI summary & descriptions.

**Additional context**

https://springdoc.org/#javadoc-support does something like that (apparently).

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by reviewing the annotation processor and the linked springdoc Javadoc support, then trace how JSON Schema and OpenAPI summary and description generation currently works. Done means JavaDoc is processed and its content is reflected in both output types.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, kotlin, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.