[MGNLRESTCL-71] Create a light module that demonstrate rest client usage Created: 24/Sep/19  Updated: 09/Oct/19  Resolved: 09/Oct/19

Status: Closed
Project: REST Client
Component/s: None
Affects Version/s: None
Fix Version/s: 2.0

Type: Task Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Jorge Franco
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLRESTUI-48 DOC: App can display external content... Accepted
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: Easy Outbound REST
Sprint: Declarative REST 7, Declarative REST 8
Story Points: 5

 Description   

User Story:

As a developer, I want to quickly be able to try rest clients, so that I can understand, test, and use them in my projects.

Notes

Create a single git repository with a single or set of examples showing how declarative rest clients can be configured and used.

These technical examples can use names of the exact feature that they are demonstrating, they dont have to be realistic scenarios.

For example there could be a light module "linkfield"

Things to include

README should contain list of all the features demonstrated, and where its demonstrated in the file:

  • Rest clients - with all their usages techniques
    • Using the template parameters and defaultValues
    • paging
    • caching
    • timeout
    • OpenAPI
  • Rest client Authentication
    • basic
    • OAUTH2
    • (Other?)
  • Template
  • Template hitting a Magnolia deliveryEndpoint.
  • Link field
  • Select field
  • App - Browser SubApp
  • Findbar
  • JS Model
  • ... every other feature.

 

Useful for:

  • Documenting what has been done in a ticket.
  • Assisting Docs team to write docs.

Resources:

JSModels samples project:

https://git.magnolia-cms.com/projects/LIGHT-MODULES/repos/javascript-model-samples/browse

Stories samples project:

https://git.magnolia-cms.com/projects/LIGHT-MODULES/repos/stories-app-samples/browse

Concept for Readme

https://wiki.magnolia-cms.com/display/TEASYINT/Easy+Rest+Demo+Project

 

 



 Comments   
Comment by Jaroslav Simak [ 24/Sep/19 ]

There's a git repo for that, it is missing few example (OpenAPI, some restfn usages, and things that is being worked on).

See this link.

Comment by Christopher Zimmermann [ 03/Oct/19 ]

Following comments are based on this LM: https://git.magnolia-cms.com/projects/MODULES/repos/rest-client/browse?at=refs%2Fheads%2FMGNLRESTCL-71

Rename "data" to "_install-manually"

To be consistant with other demo/samples modules.

Create Post page fails because JSmodel is used - but JSmodel configuration is not setup properly -

Readme needs bootstrap for it and instructions how to install it. I think this file: https://git.magnolia-cms.com/users/jsimak/repos/declarative-rest/browse/declarative-rest-demo/src/main/resources/mgnl-bootstrap/declarative-rest-demo/config.modules.javascript-models.config.yaml

Would be nice to have all demo apps in one App group - Would require this bootstrap:

https://git.magnolia-cms.com/users/jsimak/repos/declarative-rest/browse/declarative-rest-demo/src/main/resources/mgnl-bootstrap/declarative-rest-demo/config.modules.ui-admincentral.config.appLauncherLayout.groups.declarativeRest.yaml

Error on clicking "new" action in Countries app.

Click on country (actions are enabled). Deselect country. (actions REMAIN enbaled.)

Action execution failed for action: newCountry
No item in value context
(Might be a bug - might not be something you can solve in the demo project.)

 

Page /declarative-rest-demo/restfn-posts throws exception

Probably because the "single" call uses an entityClass that is not available:
info.magnolia.declarative.rest.demo.post.Post

The "all" call does to.

This light module should work on a stock webapp. It should not require any custom java code. (There can be a separate java demonstration module.)

 "js-module" is a typo in the readme., should be "js-model"

Move to Light Modules Project on Bitbucket

https://git.magnolia-cms.com/projects/LIGHT-MODULES

Rename to declarative-rest-samples

To be consistant with the other "...-samples" projects there.

(requires changing some templates and bootstraps files - but search-and-replace should work.)

Generated at Mon Feb 12 10:42:56 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.