Hey team,

Quick heads-up, speaking of degraphQL properties, methods is also important
Even though it isn't properly listed in our plugin doc

It is probably important to highlight that degraphQL plugin manage more complex GQL queries than query{ contacts { name } },
such as mutations that uses as variables objects and arrays and various searches for example.

query SearchPosts($filters: PostsFilters) {
  posts(filter: $filters) {
    id
    title
    author
  }
}

In these scenarios, GET method (default method) isn't suitable to use

Some folks are using this properly to tell degraphQL plugin to handle POST request and parse a JSON body

Example

Plugin config:

curl -X POST https://admin.api.local/services/foo/degraphql/routes \
  --data uri='/search/posts' \
  --data methods='POST' \ # ⬅️
  --data query='query SearchPosts($filters: PostsFilters) {
  posts(filter: $filters) {
    id
    title
    author
  }
}'

Usage:

curl --request POST \
  --url https://api.local/foo/search/posts \
  --header 'Content-Type: application/json' \
  --data '{ date: { between: { min: "2025-01-01", max: "2025-02-01" } } }'

curl --request POST \
  --url https://api.local/foo/search/posts \
  --header 'Content-Type: application/json' \
  --data '{
  "id": {
    "in": [
      "7cf342f2",
      "9860193d",
      "63498e1a"
    ]
  }
}'

By the way, method is an array / table and can be either or both GET & POST
Meaning the deck file would probably look like this :

plugin_entities:
  - type: degraphql_routes
    plugin: my-degraphql-plugin
    fields:
      uri: "/search/posts"
      methods: 
        - "POST"
      query: |
        query SearchPosts($filters: PostsFilters) {
          posts(filter: $filters) {
            id
            title
            author
          }
        }
      service: "<id>"  # service id, TBC

Add degraphql entity support #1346

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions