use of com.linkedin.restli.docgen.examplegen.ExampleRequestResponse in project rest.li by linkedin.
the class TestExamplesGenerator method testExamples.
@Test
public void testExamples() throws IOException {
final Map<String, ResourceModel> resources = buildResourceModels(ActionsResource.class, GreetingsResource.class, GroupsResource2.class, GroupContactsResource2.class, GroupMembershipsResource2.class, RootSimpleResource.class, CollectionUnderSimpleResource.class, SimpleResourceUnderCollectionResource.class, CustomTypesResource.class);
final ResourceSchemaCollection resourceSchemas = ResourceSchemaCollection.loadOrCreateResourceSchema(resources);
final DataSchemaResolver schemaResolver = new ClasspathResourceDataSchemaResolver(SchemaParserFactory.instance());
final ValidationOptions valOptions = new ValidationOptions(RequiredMode.MUST_BE_PRESENT);
ExampleRequestResponse capture;
ValidationResult valRet;
final ResourceSchema greetings = resourceSchemas.getResource("greetings");
ExampleRequestResponseGenerator greetingsGenerator = new ExampleRequestResponseGenerator(greetings, schemaResolver);
final ResourceSchema groups = resourceSchemas.getResource("groups");
ExampleRequestResponseGenerator groupsGenerator = new ExampleRequestResponseGenerator(groups, schemaResolver);
final ResourceSchema groupsContacts = resourceSchemas.getResource("groups.contacts");
ExampleRequestResponseGenerator groupsContactsGenerator = new ExampleRequestResponseGenerator(Collections.singletonList(groups), groupsContacts, schemaResolver);
final ResourceSchema greeting = resourceSchemas.getResource("greeting");
ExampleRequestResponseGenerator greetingGenerator = new ExampleRequestResponseGenerator(greeting, schemaResolver);
final ResourceSchema actions = resourceSchemas.getResource("actions");
ExampleRequestResponseGenerator actionsGenerator = new ExampleRequestResponseGenerator(actions, schemaResolver);
final ResourceSchema customTypes = resourceSchemas.getResource("customTypes");
ExampleRequestResponseGenerator customTypesGenerator = new ExampleRequestResponseGenerator(customTypes, schemaResolver);
List<ResourceSchema> subResources = resourceSchemas.getSubResources(greeting);
final ResourceSchema subgreetings = subResources.get(0);
ExampleRequestResponseGenerator subgreetingsGenerator = new ExampleRequestResponseGenerator(Collections.singletonList(greeting), subgreetings, schemaResolver);
subResources = resourceSchemas.getSubResources(subgreetings);
final ResourceSchema subsubgreeting = subResources.get(0);
ExampleRequestResponseGenerator subsubgreetingGenerator = new ExampleRequestResponseGenerator(Arrays.asList(greeting, subgreetings), subsubgreeting, schemaResolver);
capture = greetingsGenerator.method(ResourceMethod.GET);
valRet = validateSingleResponse(capture.getResponse(), Greeting.class, valOptions);
Assert.assertTrue(valRet.isValid(), valRet.getMessages().toString());
capture = greetingsGenerator.method(ResourceMethod.CREATE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
capture = greetingsGenerator.finder("search");
valRet = validateCollectionResponse(capture.getResponse(), Greeting.class, valOptions);
Assert.assertNull(valRet, (valRet == null ? null : valRet.getMessages().toString()));
capture = groupsContactsGenerator.method(ResourceMethod.GET);
valRet = validateSingleResponse(capture.getResponse(), GroupContact.class, valOptions);
Assert.assertTrue(valRet.isValid(), valRet.getMessages().toString());
capture = groupsGenerator.finder("search");
String queryString = capture.getRequest().getURI().getQuery();
Assert.assertTrue(queryString.contains("q=search"));
Assert.assertTrue(queryString.contains("keywords="));
Assert.assertTrue(queryString.contains("nameKeywords="));
Assert.assertTrue(queryString.contains("groupID="));
valRet = validateCollectionResponse(capture.getResponse(), Group.class, valOptions);
Assert.assertNull(valRet, (valRet == null ? null : valRet.getMessages().toString()));
capture = greetingsGenerator.action("purge", ResourceLevel.COLLECTION);
final DataMap purgeResponse = DataMapUtils.readMap(capture.getResponse());
Assert.assertTrue(purgeResponse.containsKey("value"));
capture = greetingsGenerator.action("updateTone", ResourceLevel.ENTITY);
valRet = validateCollectionResponse(capture.getResponse(), Greeting.class, valOptions);
Assert.assertNull(valRet, (valRet == null ? null : valRet.getMessages().toString()));
capture = groupsGenerator.action("sendTestAnnouncement", ResourceLevel.ENTITY);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
capture = greetingGenerator.method(ResourceMethod.GET);
valRet = validateSingleResponse(capture.getResponse(), Greeting.class, valOptions);
Assert.assertTrue(valRet.isValid(), valRet.getMessages().toString());
RestRequest request = capture.getRequest();
Assert.assertEquals(request.getURI(), URI.create("/greeting"));
capture = greetingGenerator.method(ResourceMethod.UPDATE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
request = capture.getRequest();
Assert.assertEquals(request.getURI(), URI.create("/greeting"));
valRet = validateSingleRequest(capture.getRequest(), Greeting.class, valOptions);
Assert.assertTrue(valRet.isValid(), valRet.getMessages().toString());
capture = greetingGenerator.method(ResourceMethod.PARTIAL_UPDATE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
request = capture.getRequest();
Assert.assertEquals(request.getURI(), URI.create("/greeting"));
DataMap patchMap = _codec.bytesToMap(capture.getRequest().getEntity().copyBytes());
checkPatchMap(patchMap);
capture = greetingGenerator.method(ResourceMethod.DELETE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
request = capture.getRequest();
Assert.assertEquals(request.getURI(), URI.create("/greeting"));
capture = greetingGenerator.action("exampleAction", ResourceLevel.ENTITY);
DataMap exampleActionResponse = DataMapUtils.readMap(capture.getResponse());
Assert.assertTrue(exampleActionResponse.containsKey("value"));
request = capture.getRequest();
Assert.assertTrue(validateUrlPath(request.getURI(), new String[] { "greeting" }));
capture = subgreetingsGenerator.method(ResourceMethod.CREATE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
request = capture.getRequest();
Assert.assertEquals(request.getURI(), URI.create("/greeting/subgreetings"));
valRet = validateSingleRequest(capture.getRequest(), Greeting.class, valOptions);
Assert.assertTrue(valRet.isValid(), valRet.getMessages().toString());
capture = subsubgreetingGenerator.method(ResourceMethod.GET);
valRet = validateSingleResponse(capture.getResponse(), Greeting.class, valOptions);
Assert.assertTrue(valRet.isValid(), valRet.getMessages().toString());
request = capture.getRequest();
Assert.assertTrue(validateUrlPath(request.getURI(), new String[] { "greeting", "subgreetings", null, "subsubgreeting" }));
capture = subsubgreetingGenerator.method(ResourceMethod.UPDATE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
request = capture.getRequest();
Assert.assertTrue(validateUrlPath(request.getURI(), new String[] { "greeting", "subgreetings", null, "subsubgreeting" }));
valRet = validateSingleRequest(capture.getRequest(), Greeting.class, valOptions);
Assert.assertTrue(valRet.isValid(), valRet.getMessages().toString());
capture = subsubgreetingGenerator.method(ResourceMethod.PARTIAL_UPDATE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
request = capture.getRequest();
Assert.assertTrue(validateUrlPath(request.getURI(), new String[] { "greeting", "subgreetings", null, "subsubgreeting" }));
patchMap = _codec.bytesToMap(capture.getRequest().getEntity().copyBytes());
checkPatchMap(patchMap);
capture = subsubgreetingGenerator.method(ResourceMethod.DELETE);
Assert.assertSame(capture.getResponse().getEntity().length(), 0);
request = capture.getRequest();
Assert.assertTrue(validateUrlPath(request.getURI(), new String[] { "greeting", "subgreetings", null, "subsubgreeting" }));
capture = subsubgreetingGenerator.action("exampleAction", ResourceLevel.ENTITY);
exampleActionResponse = DataMapUtils.readMap(capture.getResponse());
Assert.assertTrue(exampleActionResponse.containsKey("value"));
request = capture.getRequest();
Assert.assertTrue(validateUrlPath(request.getURI(), new String[] { "greeting", "subgreetings", null, "subsubgreeting" }));
capture = subgreetingsGenerator.finder("search");
queryString = capture.getRequest().getURI().getQuery();
Assert.assertTrue(queryString.contains("q=search"), queryString);
Assert.assertTrue(queryString.contains("id:"), queryString);
Assert.assertTrue(queryString.contains("message:"), queryString);
Assert.assertTrue(queryString.contains("tone:"), queryString);
capture = actionsGenerator.action("echoMessageArray", ResourceLevel.COLLECTION);
final DataMap echoMessageArrayResponse = DataMapUtils.readMap(capture.getResponse());
Assert.assertTrue(echoMessageArrayResponse.containsKey("value"));
capture = actionsGenerator.action("echoToneArray", ResourceLevel.COLLECTION);
final DataMap echoToneArrayResponse = DataMapUtils.readMap(capture.getResponse());
Assert.assertTrue(echoToneArrayResponse.containsKey("value"));
capture = actionsGenerator.action("echoStringArray", ResourceLevel.COLLECTION);
final DataMap echoStringArrayResponse = DataMapUtils.readMap(capture.getResponse());
Assert.assertTrue(echoStringArrayResponse.containsKey("value"));
capture = customTypesGenerator.action("action", ResourceLevel.COLLECTION);
DataMap requestMap = _codec.bytesToMap(capture.getRequest().getEntity().copyBytes());
Assert.assertTrue(requestMap.containsKey("l"));
Assert.assertEquals(requestMap.size(), 1);
final DataMap customTypesActionResponse = DataMapUtils.readMap(capture.getResponse());
Assert.assertTrue(customTypesActionResponse.containsKey("value"));
Assert.assertEquals(customTypesActionResponse.size(), 1);
}
use of com.linkedin.restli.docgen.examplegen.ExampleRequestResponse in project rest.li by linkedin.
the class RestLiHTMLDocumentationRenderer method renderResource.
@Override
public void renderResource(String resourceName, OutputStream out) {
final ResourceSchema resourceSchema = _resourceSchemas.getResource(resourceName);
final List<ResourceSchema> parentResources = _resourceSchemas.getParentResources(resourceSchema);
ExampleRequestResponseGenerator generator = new ExampleRequestResponseGenerator(parentResources, resourceSchema, _schemaResolver);
if (resourceSchema == null) {
throw new RoutingException(String.format("Resource \"%s\" does not exist", resourceName), HttpStatus.S_404_NOT_FOUND.getCode());
}
final Map<String, Object> pageModel = createPageModel();
pageModel.put("resource", resourceSchema);
pageModel.put("resourceName", resourceName);
pageModel.put("resourceFullName", ResourceSchemaUtil.getFullName(resourceSchema));
pageModel.put("resourceType", getResourceType(resourceSchema));
pageModel.put("subResources", _resourceSchemas.getSubResources(resourceSchema));
final List<ResourceMethodDocView> restMethods = new ArrayList<ResourceMethodDocView>();
final List<ResourceMethodDocView> finders = new ArrayList<ResourceMethodDocView>();
final List<ResourceMethodDocView> actions = new ArrayList<ResourceMethodDocView>();
final MethodGatheringResourceSchemaVisitor visitor = new MethodGatheringResourceSchemaVisitor(resourceName);
ResourceSchemaCollection.visitResources(_resourceSchemas.getResources().values(), visitor);
for (RecordTemplate methodSchema : visitor.getAllMethods()) {
final ExampleRequestResponse capture;
if (methodSchema instanceof RestMethodSchema) {
RestMethodSchema restMethodSchema = (RestMethodSchema) methodSchema;
capture = generator.method(ResourceMethod.valueOf(restMethodSchema.getMethod().toUpperCase()));
} else if (methodSchema instanceof FinderSchema) {
FinderSchema finderMethodSchema = (FinderSchema) methodSchema;
capture = generator.finder(finderMethodSchema.getName());
} else if (methodSchema instanceof ActionSchema) {
ActionSchema actionMethodSchema = (ActionSchema) methodSchema;
final ResourceLevel resourceLevel = (visitor.getCollectionActions().contains(methodSchema) ? ResourceLevel.COLLECTION : ResourceLevel.ENTITY);
capture = generator.action(actionMethodSchema.getName(), resourceLevel);
} else {
capture = null;
}
String requestEntity = null;
String responseEntity = null;
if (capture != null) {
try {
DataMap entityMap;
if (capture.getRequest().getEntity().length() > 0) {
entityMap = DataMapUtils.readMap(capture.getRequest());
requestEntity = new String(_codec.mapToBytes(entityMap));
}
if (capture.getResponse() != null && capture.getResponse().getEntity() != null && capture.getResponse().getEntity().length() > 0) {
entityMap = DataMapUtils.readMap(capture.getResponse());
responseEntity = new String(_codec.mapToBytes(entityMap));
}
} catch (IOException e) {
throw new RestLiInternalException(e);
}
}
final ResourceMethodDocView docView = new ResourceMethodDocView(methodSchema, capture, getDoc(methodSchema, resourceSchema.hasSimple()), requestEntity, responseEntity);
if (methodSchema instanceof RestMethodSchema) {
restMethods.add(docView);
} else if (methodSchema instanceof FinderSchema) {
finders.add(docView);
} else if (methodSchema instanceof ActionSchema) {
actions.add(docView);
}
}
pageModel.put("restMethods", restMethods);
pageModel.put("finders", finders);
pageModel.put("actions", actions);
addRelated(resourceSchema, pageModel);
_templatingEngine.render("resource.vm", pageModel, out);
}
Aggregations