Ativação de 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 Slinge no Exportador de Modelo Sling , que depende Anotações de Jackson).

Isso significa que o componente deve ter um Modelo do Sling se precisar exportar JSON. Portanto, será necessário seguir essas duas etapas para habilitar 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 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 a variável .model e o .json extensão.

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

Uso de vários seletores multiple-selectors

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

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

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

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

Para ser considerado pelo quadro do exportador JSON, a interface do modelo deve implementar a variável ComponentExporter interface (ou ContainerExporter, no caso de um componente de contêiner).

A interface correspondente do Modelo do Sling ( MyComponent) seria anotada usando Anotações de Jackson para definir como ele deve ser exportado (serializado).

A interface Modelo precisa ser anotada corretamente para definir quais métodos devem ser serializados. Por padrão, todos os métodos que respeitam a convenção de nomenclatura usual para getters serão serializados e derivarão seus nomes de propriedades JSON naturalmente dos nomes getter. Isso pode ser evitado ou substituído por @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 usadas como referência.

Para obter um exemplo, consulte a implementação do Modelo do 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

Para obter mais detalhes, consulte: