Enable jsonschema support in debug page for annotated too #5253
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -98,6 +98,27 @@ public MethodInfo(String serviceName, String name, | |
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new instance. | ||
| */ | ||
| public MethodInfo(String serviceName, String name, | ||
|
There was a problem hiding this comment. I have added yet more craziness to this file. Hopefully not for this PR, but probably need to get a builder in |
||
| TypeSignature returnTypeSignature, | ||
| Iterable<FieldInfo> parameters, | ||
| boolean useParameterAsRoot, | ||
| Iterable<TypeSignature> exceptionTypeSignatures, | ||
| Iterable<EndpointInfo> endpoints, | ||
| Iterable<HttpHeaders> exampleHeaders, | ||
| Iterable<String> exampleRequests, | ||
| Iterable<String> examplePaths, | ||
| Iterable<String> exampleQueries, | ||
| HttpMethod httpMethod, | ||
| DescriptionInfo descriptionInfo) { | ||
| this(name, returnTypeSignature, parameters, useParameterAsRoot, | ||
| exceptionTypeSignatures, endpoints, exampleHeaders, | ||
| exampleRequests, examplePaths, exampleQueries, httpMethod, descriptionInfo, | ||
| createId(serviceName, name, 0, httpMethod)); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new instance. | ||
| */ | ||
|
|
@@ -112,11 +133,12 @@ public MethodInfo(String serviceName, String name, | |
| Iterable<String> examplePaths, | ||
| Iterable<String> exampleQueries, | ||
| HttpMethod httpMethod, | ||
| DescriptionInfo descriptionInfo, | ||
| int overloadId) { | ||
| this(name, returnTypeSignature, parameters, useParameterAsRoot, | ||
| exceptionTypeSignatures, endpoints, exampleHeaders, | ||
| exampleRequests, examplePaths, exampleQueries, httpMethod, descriptionInfo, | ||
| createId(serviceName, name, overloadId, httpMethod)); | ||
| } | ||
|
|
||
| MethodInfo(String name, TypeSignature returnTypeSignature, | ||
|
|
@@ -130,7 +152,6 @@ public MethodInfo(String serviceName, String name, | |
|
|
||
| this.returnTypeSignature = requireNonNull(returnTypeSignature, "returnTypeSignature"); | ||
| this.parameters = ImmutableList.copyOf(requireNonNull(parameters, "parameters")); | ||
|
There was a problem hiding this comment. I could tweak the assertion to look for a single root parameter but it seemed like overkill There was a problem hiding this comment. Note: the following is also a valid method that has multiple resolvers, but uses headers/query params instead of the body to fill the bean. Since the last non-param/query will be used, in the worst case it is possible that wrong autocomplete/recommendations are done. @Post("/bean2")
public HttpResponse bean2(@RequestObject JsonRequest jsonRequest, CompositeBean compositeBean1) {
return HttpResponse.of("world");
}Having said this, I'm not sure if there is a non-trivial way to intelligently find the parameter that should be used as the body. |
||
| this.useParameterAsRoot = useParameterAsRoot; | ||
|
|
||
| this.exceptionTypeSignatures = | ||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,7 @@ | |
| import static com.linecorp.armeria.internal.server.annotation.AnnotatedDocServicePluginTest.compositeBean; | ||
| import static com.linecorp.armeria.server.docs.FieldLocation.PATH; | ||
| import static com.linecorp.armeria.server.docs.FieldLocation.QUERY; | ||
| import static com.linecorp.armeria.server.docs.FieldRequirement.OPTIONAL; | ||
| import static com.linecorp.armeria.server.docs.FieldRequirement.REQUIRED; | ||
| import static net.javacrumbs.jsonunit.core.Option.IGNORING_ARRAY_ORDER; | ||
| import static net.javacrumbs.jsonunit.fluent.JsonFluentAssert.assertThatJson; | ||
|
|
@@ -65,6 +66,7 @@ | |
| import com.linecorp.armeria.common.HttpStatus; | ||
| import com.linecorp.armeria.common.MediaType; | ||
| import com.linecorp.armeria.common.MediaTypeNames; | ||
| import com.linecorp.armeria.common.annotation.Nullable; | ||
| import com.linecorp.armeria.common.util.UnmodifiableFuture; | ||
| import com.linecorp.armeria.internal.server.annotation.AnnotatedDocServicePluginTest.CompositeBean; | ||
| import com.linecorp.armeria.internal.testing.TestUtil; | ||
|
|
@@ -336,15 +338,24 @@ private static void addJsonMethodInfo(Map<Class<?>, Set<MethodInfo>> methodInfos | |
| final EndpointInfo endpoint1 = EndpointInfo.builder("*", "exact:/service/json") | ||
| .availableMimeTypes(MediaType.JSON_UTF_8) | ||
| .build(); | ||
| // request is moved to front even though it is the middle in the Java definition. | ||
| final List<FieldInfo> fields = ImmutableList.of( | ||
| FieldInfo.builder("request", TypeSignature.ofStruct(JsonRequest.class)) | ||
| .requirement(REQUIRED) | ||
| .build(), | ||
| FieldInfo.builder("query1", TypeSignature.ofBase("string")) | ||
| .location(QUERY) | ||
| .requirement(OPTIONAL) | ||
| .build(), | ||
| FieldInfo.builder("query2", TypeSignature.ofBase("string")) | ||
| .location(QUERY) | ||
| .requirement(OPTIONAL) | ||
| .build()); | ||
| final MethodInfo methodInfo1 = new MethodInfo( | ||
| MyService.class.getName(), "json", 0, STRING, fields, ImmutableList.of(), | ||
| ImmutableList.of(endpoint1), HttpMethod.POST, DescriptionInfo.empty()); | ||
| final MethodInfo methodInfo2 = new MethodInfo( | ||
| MyService.class.getName(), "json", 0, STRING, fields, ImmutableList.of(), | ||
| ImmutableList.of(endpoint1), HttpMethod.PUT, DescriptionInfo.empty()); | ||
| final Set<MethodInfo> methods = methodInfos.computeIfAbsent(MyService.class, unused -> new HashSet<>()); | ||
| methods.add(methodInfo1); | ||
|
|
@@ -642,7 +653,8 @@ public HttpResponse multi() { | |
| @Path("/json") | ||
| @Post | ||
| @Put | ||
| public String json( | ||
| @Param @Nullable String query1, JsonRequest request, @Param @Nullable String query2) { | ||
| return request.bar; | ||
| } | ||
|
|
||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -55,12 +55,11 @@ const RequestBody: React.FunctionComponent<Props> = ({ | |||||
| }) => { | ||||||
| const monacoEditor = useMonaco(); | ||||||
|
|
||||||
| const forceJsonSchema = | ||||||
| serviceType === ServiceType.GRPC || serviceType === ServiceType.THRIFT; | ||||||
| const hasJsonSchema = useMemo(() => { | ||||||
| const schema = jsonSchemas.find((s: any) => s.$id === method.id); | ||||||
| if (schema && (schema.useParamaterAsRoot || forceJsonSchema)) { | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| monacoEditor?.languages.json.jsonDefaults.setDiagnosticsOptions({ | ||||||
| validate: true, | ||||||
| schemas: [ | ||||||
|
|
@@ -71,12 +70,13 @@ const RequestBody: React.FunctionComponent<Props> = ({ | |||||
| }, | ||||||
| ], | ||||||
| }); | ||||||
| return true; | ||||||
| } | ||||||
| monacoEditor?.languages.json.jsonDefaults.setDiagnosticsOptions({ | ||||||
| validate: false, | ||||||
| }); | ||||||
| return false; | ||||||
| }, [monacoEditor, jsonSchemas, method.id, forceJsonSchema]); | ||||||
|
|
||||||
| return ( | ||||||
| <> | ||||||
|
|
@@ -109,7 +109,7 @@ const RequestBody: React.FunctionComponent<Props> = ({ | |||||
| <Typography variant="body2" paragraph /> | ||||||
| <Editor | ||||||
| height="30vh" | ||||||
| language={hasJsonSchema ? 'json' : undefined} | ||||||
| theme="vs-light" | ||||||
| options={{ | ||||||
| minimap: { enabled: false }, | ||||||
|
|
||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.