Documentazione AEM Guides Documentazione di AEM Guides

Introduzione id1761C0007W7

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Argomenti:
Introduzione API

Creato per:

Esperto
Sviluppatore

Adobe Experience Manager Guides (in seguito denominato AEM Guides) è una soluzione aziendale end-to-end che consente a Adobe Experience Manager (AEM) di disporre delle funzionalità della soluzione di gestione dei contenuti dei componenti (CCMS) per la creazione e la distribuzione di contenuti basati su DITA. I clienti possono accedere ai flussi di lavoro di AEM Guides a livello di programmazione utilizzando le API di AEM Guides per integrarlo con altre applicazioni aziendali. Queste API possono essere utilizzate anche dai partner Adobe per migliorare la proposta di valore di AEM Guides estendendone le funzionalità o integrandola con altre applicazioni o servizi.

API di AEM Guides

Le API di AEM Guides sono disponibili in due formati: HTTP e Java. Queste API espongono le funzioni chiave di AEM Guides agli sviluppatori di applicazioni. Utilizzando queste funzioni, gli sviluppatori possono creare i propri plug-in per estendere i flussi di lavoro preconfigurati. Le API sono disponibili per la gestione degli output per il contenuto DITA, l'utilizzo delle mappe DITA, l'aggiunta di attributi condizionali ai profili a livello di cartella e la conversione di documenti HTML e Words in formato DITA.

Installazione dei JAR nell’archivio Apache Maven locale install-jar-local

Per poter utilizzare i file JAR esposti da AEM Guides, devi installarli nell’archivio Apache Maven locale. Per installare i JAR nel percorso dell’archivio Maven, effettua le seguenti operazioni:

Estrai il contenuto del file del pacchetto AEM Guides (.zip) sul sistema locale.

Al prompt dei comandi passare alla cartella seguente nel percorso del contenuto estratto:

code language-none
`\jcr_root\libs\fmdita\osgi-bundles\install`

Esegui il seguente comando per installare il bundle API nell’archivio Maven locale:

code language-none
`mvn install:install-file -Dfile=api-X.x.jar -DgroupId=com.adobe.fmdita -DartifactId=api -Dversion=X.x -Dpackaging=jar**`

note note
NOTE
Nel comando precedente, X.x deve essere sostituito con il numero di versione effettivo nei parametri Dfile e Dversion.

(Facoltativo) Installa la dipendenza nell’archivio del progetto Maven locale. Per ottenere questo risultato, crea una cartella nel progetto Maven ed esegui il comando mvn install fornito nel passaggio precedente con il seguente parametro aggiuntivo:

code language-none
`-DlocalRepositoryPath=<path_to_project_repository>`

Quindi, per esporre la cartella dell’archivio locale del progetto al processo di compilazione Maven, aggiungi un elemento repository nel file pom.xml padre come mostrato di seguito:

code language-xml
`<repositories> <repository> <id>project-repository</id> <url>file://${project.basedir}/repository</url> </repository> </repositories>`

Questo processo installa i JAR API nell’archivio Maven locale.

Utilizzo del JAR dell’API di servizio in un progetto Maven

Dopo aver installato i JAR API nell’archivio Maven locale, esegui i seguenti passaggi per utilizzare i JAR nei progetti:

Aggiungi il file JAR alla base di codice e esegui il commit nell’archivio della base di codice in una cartella, ad esempio "dependencies". Il nome della cartella dipende dalla gerarchia della base di codice.

Configura i file pom.xml del progetto come segue:

File pom.xml del progetto padre:

note important
IMPORTANT
Nel seguente snippet di codice, X.x deve essere sostituito con il numero di versione effettivo e il nome del file JAR dell’API. Queste informazioni saranno le stesse fornite nel passaggio 3 del processo di installazione.

code language-xml

code language-xml
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> <configuration> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>X.x</version> <file>${basedir}/dependencies/fmdita/api-X.x.jar</file> <packaging>jar</packaging> <generatePom>true</generatePom> </configuration> <executions> <execution> <id>inst_fmdita</id> <goals> <goal>install-file</goal> </goals> <phase>clean</phase> </execution> </executions> </plugin>

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

   <artifactId>maven-install-plugin</artifactId>

    <version>2.5.2</version>

    <configuration>

            <groupId>com.adobe.fmdita</groupId>

            <artifactId>api</artifactId>

            <version>X.x</version>

            <file>${basedir}/dependencies/fmdita/api-X.x.jar</file>

            <packaging>jar</packaging>

            <generatePom>true</generatePom>

    </configuration>

    <executions>

        <execution>

            <id>inst_fmdita</id>

                <goals>

                    <goal>install-file</goal>

                </goals>

                <phase>clean</phase>

        </execution>

    </executions>
</plugin>

File pom.xml del modulo secondario:

code language-xml

code language-xml
`<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <configuration> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>3.6</version> <file>${basedir}/../dependencies/fmdita/api-3.6.jar</file> <packaging>jar</packaging> <generatePom>true</generatePom> </configuration> <executions> <execution> <id>inst_fmdita</id> <goals> <goal>install-file</goal> </goals> <phase>clean</phase> </execution> </executions> </plugin>`

<plugin>
   <groupId>org.apache.maven.plugins</groupId>

   <artifactId>maven-install-plugin</artifactId>

   <configuration>

      <groupId>com.adobe.fmdita</groupId>

      <artifactId>api</artifactId>

      <version>3.6</version>

      <file>${basedir}/../dependencies/fmdita/api-3.6.jar</file>

      <packaging>jar</packaging>

      <generatePom>true</generatePom>

   </configuration>

   <executions>

      <execution>

         <id>inst_fmdita</id>

         <goals>

            <goal>install-file</goal>

         </goals>

         <phase>clean</phase>

      </execution>

   </executions>

</plugin>

Configurare e utilizzare il servizio API JAR dall’archivio Maven pubblico

Per configurare e utilizzare i JAR dell’API del servizio dall’archivio Maven pubblico nei progetti, effettua le seguenti operazioni:

Per utilizzare il file JAR dell’API di servizio in un progetto, configura l’archivio Maven pubblico di AEM Guides nel file pom.xml.

Configura l’archivio Maven pubblico nel file settings.xml di Maven come segue:

code language-xml
`<repository> <id>fmdita-public</id> <name>fmdita-public</name> <url>https://repo.aem-guides.com/repository/fmdita-public</url> </repository>`

Una volta configurato l’archivio, aggiungi il JAR dell’API del servizio come dipendenza dal progetto nel file pom.xml del progetto.

note note
NOTE
Utilizza la stessa versione del JAR API del pacchetto AEM Guides installato sul server.

Configura la dipendenza Maven come mostrato di seguito:

code language-xml
`<dependency> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>4.0</version> </dependency>`

Una volta aggiunto il file JAR dell’API di servizio come dipendenza dal progetto nel file pom.xml del progetto, puoi creare e utilizzare le API Java di AEM Guides nel progetto.

Utilizzo di API JAR dall’archivio centrale Maven per AEM Guides as a Cloud Service

Per AEM Guides as a Cloud Service, il file JAR dell’API è stato distribuito a Maven Central. Puoi utilizzare il file JAR dell’API senza alcuna configurazione.

NOTE

La convenzione di denominazione del file jar dell’API è stata aggiornata in base alla convenzione di denominazione dei componenti aggiuntivi per cloud.

Per utilizzare il file JAR API, devi aggiungere la dipendenza al pom.xml del progetto come mostrato di seguito:

<dependency>
   <groupId>com.adobe.aem</groupId>
   <artifactId>aem-guides-sdk-api</artifactId>
   <version>2022.5</version>
</dependency>

NOTE

Poiché i pacchetti all’interno del JAR API sono ancora gli stessi, non è necessaria alcuna modifica del codice per utilizzare questo JAR API nei progetti cloud esistenti.

Risorse aggiuntive

Di seguito è riportato un elenco di altre utili risorse di AEM Guides, disponibili nella pagina Informazioni e supporto:

Guida utente
Guida all’installazione e alla configurazione
Guida rapida
Pagina di archiviazione della Guida (accedere alla documentazione delle versioni precedenti)

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178