parameter types about restdocs-api-spec HOT 6 CLOSED

Hey @pax95 ,

Spring restdocs tries to infer the type from the example bodies, but you can override this with:

fieldWithPath("featurings").type(JsonFieldType.ARRAY).description("List of featuring artist if any")

You need to use JsonFieldType types and not the Java types. I hope, this helps!

from restdocs-api-spec.

Sounds reasonable. I think this could be done by extending the PathDescriptor from spring-restdocs.

Would you be in to give it a try.

from restdocs-api-spec.

@mduesterhoeft yeah, I'd be happy to give it a shot. If there are any pointers that you can share to help me get started, that'd be great!

from restdocs-api-spec.

Looks like we already have that:

You can specify the type of a parameter using the type() method.

.pathParameters(
                            parameterWithName("someId").description("some id"),
                            parameterWithName("otherId").description("otherId id").type(SimpleType.INTEGER)
                    )

from restdocs-api-spec.

Is there a similar way to specify a ARRAY type. Setting the type to java.util.List generates ->
{
"attributes" : { },
"description" : "List of featuring artist if any",
"ignored" : false,
"path" : "[].musicInfo.featurings[]",
"type" : "java.util.List",
"optional" : true
}
in resource.json where it should have been ARRAY

Update:
Found the answer in another issue. Just use JsonFieldType.ARRAY for array type it seems.

from restdocs-api-spec.

This should be working by now, see
#181 (comment) and the linked example:
https://github.com/ePages-de/restdocs-api-spec/pull/185/files#diff-672ed55d0ceac62de36f9aa7020d71ca27d6bbb03b9c0d7777699d21287191b5R298-R321

from restdocs-api-spec.