close

Filter

loading table of contents...

Headless Server Developer Manual / Version 2010

Table Of Contents

Headless Server Developer Manual

Copyright CoreMedia GmbH © 2021

CoreMedia GmbH

Ludwig-Erhard-Straße 18

20459 Hamburg

International

All rights reserved. No part of this manual or the corresponding program may be reproduced or copied in any form (print, photocopy or other process) without the written permission of CoreMedia GmbH.

Germany

Alle Rechte vorbehalten. CoreMedia und weitere im Text erwähnte CoreMedia Produkte sowie die entsprechenden Logos sind Marken oder eingetragene Marken der CoreMedia GmbH in Deutschland. Alle anderen Namen von Produkten sind Marken der jeweiligen Firmen.

Das Handbuch bzw. Teile hiervon sowie die dazugehörigen Programme dürfen in keiner Weise (Druck, Fotokopie oder sonstige Verfahren) ohne schriftliche Genehmigung der CoreMedia GmbH reproduziert oder vervielfältigt werden. Unberührt hiervon bleiben die gesetzlich erlaubten Nutzungsarten nach dem UrhG.

Licenses and Trademarks

All trademarks acknowledged.

March 23, 2021

1. Preface
1.1. Audience
1.2. CoreMedia Services
1.2.1. Registration
1.2.2. CoreMedia Releases
1.2.3. Documentation
1.2.4. CoreMedia Training
1.2.5. CoreMedia Support
1.3. Typographic Conventions
1.4. Changelog
2. Overview
3. Configuration and Operation
3.1. Configuration of the Headless Server
3.2. Endpoints of the Headless Server
3.3. Preview
3.3.1. JSON Preview Client
3.3.2. Custom Preview Client
3.4. Security
3.4.1. Whitelisting of GraphQL Queries
3.4.2. Limiting the Size of a Search Result
3.4.3. Limiting the Depth of a GraphQL Query
3.4.4. Limiting the Complexity of a GraphQL Query
3.4.5. Enforcing an Execution Timeout for GraphQL Queries
4. Development
4.1. Defining the GraphQL Schema
4.2. The @fetch Directive
4.3. The @inherit Directive
4.4. Model Mapper
4.5. Filter Predicates
4.6. Adapter
4.7. Building Links
4.7.1. Link Composer for ID links
4.7.2. Link Composer for hyperlinks
4.7.3. Implementing Custom Link Composer
4.8. Content Schema
4.8.1. Simple Article Query
4.8.2. Article Query with Fragments and Parameters
4.8.3. Querying all available Sites
4.8.4. Site Query
4.8.5. Querying derived Sites
4.8.6. Page Query
4.8.7. Download Query
4.8.8. Querying localized variants
4.9. Search
4.10. Dynamic Query Lists
4.11. Product Lists
4.12. Using Time Dependent Visibility
4.13. Remote Links
5. Rich Text Output
5.1. The Include Directive
5.2. YAML Anchors and Aliases
5.3. Code Comments
5.4. Name Property
5.5. Elements Property
5.6. Classes Property
5.7. Contexts and InitialContext Property
5.7.1. Context Types
5.7.2. Handlers
5.8. HandlerSets Property
5.9. Internal Links
5.10. External Links
6. eCommerce Extension
6.1. Products
6.2. Categories
6.3. Catalogs
6.4. Augmentation
6.4.1. Categories and Products Mapped to Media Content
6.4.2. Augmented Categories and Products
6.4.3. Augmented Pages
6.5. eCommerce Setup and Configuration
7. Personalization Extension
7.1. Retrieve CMSelectionRules Documents
7.2. Rules
8. Persisted Queries
8.1. Loading Persisted Queries at Server Startup
8.1.1. Defining Persisted Queries in Plain GraphQL
8.1.2. Defining Persisted Query Maps in Apollo Format
8.1.3. Defining Persisted Query Maps in Relay Format
8.2. Query Whitelisting
8.3. Apollo Automatic Persisted Queries
9. REST Access to GraphQL
9.1. Mapping REST Access to Persisted Queries
9.2. JSLT Transformation
10. Site Filter
11. Metadata Root
11.1. PDE Mapping as Metadata
12. Frontend Client Development
12.1. Getting Started
12.1.1. Prerequisites
12.1.2. Setting up a React App
12.1.3. Setup Apollo for GraphQL
12.1.4. Developer Tools
12.2. Basic Guides
12.2.1. Retrieving All Sites from CoreMedia Headless Server
12.2.2. Configuring Apollo Cache
12.2.3. Rendering the Homepage of a Site
12.2.4. Navigation and Routing
12.2.5. Rendering an Article
12.3. Stand Alone Component
12.3.1. Usage
12.3.2. Caching and rendering the requested placement
13. Configuration Property Reference
Glossary
Index

Search Results

Table Of Contents