[DOCU-1006] Overview "How to get json" Created: 26/Apr/17  Updated: 03/Jul/17  Resolved: 06/Jun/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Done Votes: 2
Labels: core
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Date of First Response:
Sprint: Docu Sprint 25, Docu Sprint 26
Story Points: 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



 Comments   
Comment by Christoph Meier [ 06/Jun/17 ]

Basically all done.
Virtual URI mappings config must be checked / improved, but besides that, the page is ready for a linguistic review to be done by jlegendre.

Generated at Mon Feb 12 01:14:18 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.