XMLWordPrintable

Details

    • Story
    • Resolution: Fixed
    • Neutral
    • 1.0
    • None
    • None
    • Yes
    • HL & LD 25, HL & LD 26
    • 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. 

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                jsimak Jaroslav Simak
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD