Ativar exportação em JSON para um componente enabling-json-export-for-a-component

Os componentes podem ser adaptados para gerar a exportação JSON de seu conteúdo com base em uma estrutura de modelador.

Visão geral overview

A exportação JSON é baseada em Modelos Sling e na estrutura Exportador de Modelo Sling (que se baseia em Anotações Jackson).

Essa abordagem significa que o componente deve ter um Modelo Sling se precisar exportar JSON. Portanto, siga estas duas etapas para ativar a exportação JSON em qualquer componente.

Definir um modelo do Sling para o componente define-a-sling-model-for-the-component

Primeiro, um Modelo do Sling deve ser definido para o componente.

A classe de implementação do Modelo do Sling deve ser anotada com o seguinte:

@Model(... adapters = {..., ComponentExporter.class})
@Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME, extensions = ExporterConstants.SLING_MODEL_EXTENSION)
@JsonSerialize(as = MyComponent.class)

Isso garante que seu componente possa ser exportado sozinho, usando o seletor .model e a extensão .json.

Além disso, especifica que a classe Modelo Sling pode ser adaptada à interface ComponentExporter.

Usar vários seletores multiple-selectors

Embora não seja um caso de uso padrão, é possível configurar vários seletores além do seletor model.

https://<server>:<port>/content/page.model.selector1.selector2.json

No entanto, nesse caso, o seletor model deve ser o primeiro e a extensão deve ser .json.

Anotar a interface do Modelo do Sling annotate-the-sling-model-interface

Para que a estrutura do Exportador JSON processe-a, a interface Modelo deve implementar a interface ComponentExporter (ou ContainerExporter para um componente de contêiner).

A interface do Modelo Sling correspondente ( MyComponent) seria então anotada usando anotações Jackson para definir como ela deve ser exportada (serializada).

A interface do modelo deve ser anotada corretamente para definir quais métodos são serializados. Por padrão, todos os métodos que respeitam a convenção de nomenclatura usual para getters são serializados e derivam seus nomes de propriedade JSON naturalmente dos nomes de getter. Esta abordagem pode ser impedida ou substituída usando @JsonIgnore ou @JsonProperty para renomear a propriedade JSON.

Exemplo example

Os Componentes Principais têm suporte para exportação JSON desde a versão 1.1.0 dos componentes principais e podem ser usados como referência.

Para obter um exemplo, consulte a implementação do Modelo Sling do Componente principal de imagem e sua interface anotada.

CÓDIGO NO GITHUB

Você pode encontrar o código desta página no GitHub

Documentação relacionada related-documentation