[DOCU-678] Document how to create a json-provider using magnolia templating Created: 24/Feb/16 Updated: 29/May/18 Resolved: 28/May/18 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Story | Priority: | Neutral |
| Reporter: | Christopher Zimmermann | Assignee: | Christoph Meier |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Template: |
|
||||
| Acceptance criteria: |
Empty
|
||||
| Date of First Response: | |||||
| Description |
|
Rest module provides out of the box rest endpoints and the abilty to define custom endpoints. But there is another technique that customers use which is to use a page template to output json (or maybe xml as well) instead of html. There are other advantages - such as you dont need to setup additional security to get it to work. |
| Comments |
| Comment by Christoph Meier [ 24/Feb/16 ] |
|
Theoretically i got the point. |
| Comment by Christopher Zimmermann [ 24/Feb/16 ] |
|
Yeah - I would just explain the basic principle that a template can output json. |
| Comment by Christopher Zimmermann [ 24/Feb/16 ] |
|
I would ask Tomas about the other differences to REST module endpoints - ie security and translation. But missing the rest-tools support that the REST module provides. |
| Comment by Christoph Meier [ 02/Dec/16 ] |
|
Since jsonfn comes closer and closer to the product moving into the Magnolia repo too - now i even more believe that jsonfn is the way to go. |
| Comment by Christoph Meier [ 25/Apr/17 ] |
|
czimmermann, as you have seen jsonfn docs are out now. |
| Comment by Christopher Zimmermann [ 25/Apr/17 ] |
|
Good question, but yes this ticket is still valid. I think it could be addressed without too much actual text. jsonfn ref is useful. REST api docs are useful. But I see the need for an overview of the whole topic - mentioning the different approaches and when you would use them. |
| Comment by Christopher Zimmermann [ 25/Apr/17 ] |
|
Good that you raise this because we should have this in place in time for Q3 marketing theme. (july 1 at the latest) |
| Comment by Christoph Meier [ 26/Apr/17 ] |
|
czimmermann atm rather needs what is filed in |
| Comment by Christoph Meier [ 28/May/18 ] |
|
I would say that's now tackled with https://documentation.magnolia-cms.com/display/DOCS56/How+to+get+content+as+JSON+-+an+overview |
| Comment by Christopher Zimmermann [ 29/May/18 ] |
|
Definitely. thumbs up. |