Skip to content

Fix Form OpenAPI generation #673

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 22, 2025
+227 −175
Merged

Fix Form OpenAPI generation #673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7164ba6
fix form openAPI
SentryMan Nov 21, 2025
5528f34
Format only
rbygrave Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions http-generator-core/src/main/java/io/avaje/http/generator/core/MethodParam.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,19 @@ public void buildParamName(Append writer) {
}

public void buildApiDocumentation(MethodDocBuilder methodDoc) {
if (elementParam.paramType() != ParamType.BEANPARAM) {
if (elementParam.paramType() != ParamType.BEANPARAM && elementParam.paramType() != ParamType.FORM) {
elementParam.buildApiDocumentation(methodDoc);
} else {
asElement(elementParam.element().asType()).getEnclosedElements().stream()
.filter(e -> e.getKind() == ElementKind.FIELD)
.map(VariableElement.class::cast)
.forEach(e -> buildDoc(methodDoc, e));
.forEach(e -> buildDoc(methodDoc, e, elementParam.paramType() == ParamType.FORM));
}
}

private static void buildDoc(MethodDocBuilder methodDoc, VariableElement e) {
private static void buildDoc(MethodDocBuilder methodDoc, VariableElement e, boolean form) {
final var typeMirror = e.asType();
new ElementReader(e, Util.parse(typeMirror.toString()), Util.typeDef(typeMirror), ParamType.QUERYPARAM, false)
new ElementReader(e, Util.parse(typeMirror.toString()), Util.typeDef(typeMirror), form ? ParamType.FORMPARAM : ParamType.QUERYPARAM, form)
.buildApiDocumentation(methodDoc);
}

Expand Down
4 changes: 4 additions & 0 deletions tests/test-javalin-jsonb/src/main/java/org/example/myapp/web/test/MyForm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
package org.example.myapp.web.test;

import io.avaje.http.api.Header;

public class MyForm {

public String name;
public String email;
public String url;
@Header
public String headString;
}
7 changes: 7 additions & 0 deletions tests/test-javalin-jsonb/src/main/java/org/example/myapp/web/test/OpenAPIController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import io.avaje.http.api.Controller;
import io.avaje.http.api.Delete;
import io.avaje.http.api.Form;
import io.avaje.http.api.Get;
import io.avaje.http.api.Header;
import io.avaje.http.api.MediaType;
Expand Down Expand Up @@ -107,4 +108,10 @@ String testDefaultStatus(Context ctx) {
String testPathParam(String type, @QueryParam String lastName, @QueryParam("q-2") String param2, @Header String contentLength, @Header("x-oh") String otherHeader) {
return "only partial info";
}

@Form
@Post("/form")
String testForm(MyForm form) {
return "only partial info";
}
}
Loading