[MGNLGQL-21] GraphiQL UI Created: 13/May/20  Updated: 23/Apr/21  Resolved: 12/Apr/21

Status: Closed
Project: Magnolia GraphQL
Component/s: None
Affects Version/s: None
Fix Version/s: 1.0

Type: Story Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Jaroslav Simak
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: HTML File simple-graphiql.html    
Issue Links:
causality
is causing MGNLGQL-87 DOC: Add GraphQL app to documentation Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Documentation update required:
Yes
Date of First Response:
Epic Link: GraphQL Phase 1
Sprint: HL & LD 25, HL & LD 26
Story Points: 5

 Description   

User story:

As a developer providing a GraphQL API, I want to easily test the API in the GraphiQL UI, so that I can verify that it is working correctly.

As a developer using a GraphQL API, I want to easily explore the API in the GraphiQL UI, so that I can understand the API and work in a tool that I am familiar with

Value:

  • Self-documents the API of Magnolia. (Similar to "Rest tools" swagger app.)
  • Useful for developers to experiment and build queries
  • Good way to demo and hilight value and power of GraphQL feature.
  • Provides a visual "face" for the GraphQL feature
  • Gives us "feature parity" with other CMS which include GraphiQL UI out of the box

 

Acceptance criteria:

  • GraphiQL is available on the author instance by default if you install the GraphQL module.
  • GraphiQL can be run in a browser tab by itself (with no Magnolia chrome)  once you know the correct URL.
  • GraphiQL is available in an App
  • Access to GraphiQL is limited by magnolia user security system.

 

Notes

Opensource GraphiQL UI Tool: https://github.com/graphql/graphiql

Simple CDN based graphiql example is attached "simple-graphiql.html". It appears that one can provision a GraphiQL UI with frontend resources alone. 


Generated at Mon Feb 12 05:51:47 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.