Custom Content Delivery API development

Overview of custom CDA development

For stable production functionality, it typically makes more sense to build a custom Content Delivery endpoint via code, rather than entirely through editorial configuration. An endpoint class can ensure that a fixed set of APIs are exposed with configuration that should not change between different environments.

Implementing custom CDAs

1. Create a new Java class extending ContentDeliveryApiEndpoint.
2. Implement required methods:

• getPathSuffix—appended to /graphql/delivery/ to create the path where the API endpoint is available.
• getQueryEntryFields—objects wrapping view model and interface classes used to generate the schema and expose APIs.

Example:

showLineNumbers

1
public class FooContentDeliveryApiEndpoint extends ContentDeliveryApiEndpoint {
2

3
    @Override
4
    protected String getPathSuffix() {
5
        return "foo"; // API endpoint is available at path '/graphql/delivery/foo'
6
    }
7

8
    @Override
9
    public List<ContentDeliveryEntryPointField> getQueryEntryFields() {
10
        return Arrays.asList(
11
               new ContentDeliveryEntryPointField(FooViewModel.class),
12
               new ContentDeliveryEntryPointField(BarViewModel.class));
13
    }
14
}