Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-1006

Overview "How to get json"

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Neutral
    • None
    • None
    • None
    • Docu Sprint 25, Docu Sprint 26
    • 13

    Description

      Task

      Give an overview about how to get json of (JCR based) content - showing all possible approaches:

      • Using the standard endpoints for nodes and properties
      • Using custom endpoints
      • freemarker based json-provider (typically using jsonfn, but all templating features are available.)
      • using jsonfn

      Plus providing hints , such as:

      • combining an ftl/template based json provider with virtual URI mappings to create a REST-full API
      • localize content / i18n: How to set the locale to get the content in the appropriate language
      • Same-origin policy issue & using CORS filter
      • Creating rest endpoints that deliver pure json, vs outputting required json directly in the page that uses it.
      • Using template variant to output json specifically for one component - then using DCR to access it. (Ask Schulte or Gregovsky)

      Resources

      Examples

      Timing

      According to czimmermann - this task should be finished before Q3 starts - e.g. must be finished before 1st of July.

      Reason & Audience

      More and more people want to use frontend frameworks with a CMS or have other headless scenarios. for many this will be one of the first steps in evaluation. So the approaches should be clear

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                cmeier Christoph Meier
                cmeier Christoph Meier
                Votes:
                2 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: