RESTified GraphQL Endpoints API Reference¶

Request¶

Endpoints are determined by the URL templates:

• Simple URLs such as /s1/s2/s3 match literally.
• Segments starting with a : treat these parts of the path like wildcards and use the name to assign a variable. For example: /s1/:id/s3.

The request expects a normal REST style request to the endpoint.

Variables can be supplied via route patterns, url query variables, and request body JSON object keys.

• JSON Body Object values are passed directly to the associated query with no additional validation or type-coersion.
• Route variables and Query parameters are interpreted as scalars according to the variables types in the associated query and passed as JSON data through the query variables:
  • Missing nullable variables are interpreted as NULL
  • Boolean variables are interpreted as Boolean
  • Boolean flags without values e.g. /api/rest/myquery?mybool are interpreted as true
  • String variables are interpreted as String
  • UUID variables are interpreted as String
  • ID variables are interpreted as String
  • Number, Int, Float, and Double variables are interpreted as Number
  • All other types or mismatches currently report variable type errors

When making a request to this API only one endpoint should match. If multiple endpoints match your request this is considered an error and will report so via a 500 status code. If endpoints exist with your path, but none matching your HTTP method then a 405 error will be returned listing the methods that you can use.

GET /api/rest/simple_query/1 HTTP/1.1

POST /api/rest/complicated_mutation/2?time=now HTTP/1.1
Content-Type: application/json

{
     "user": {"name": "Simon"}
}

Response¶

The response is determined by the saved query. The response will be the same as if you had made the query directly in the GraphQL console.

See the GraphQL API Reference for more details.

Sample request¶

GET /api/swagger/json HTTP/1.1
X-Hasura-Role: admin

Response¶

{
  "openapi": "3.0.0",
  "info": {
      "version": "",
      "title": "Rest Endpoints",
      "description": "These OpenAPI specifications are automatically generated by Hasura."
  },
  "paths": {
      "/api/rest/users": {
          "get": {
              "summary": "Fetch user data",
              "description": "This API fetches user data (first name and last name) from the users table.\n***\nThe GraphQl query for this endpoint is:\n``` graphql\nquery MyQuery{\n  users {\n    first_name\n    last_name\n  }\n}\n```",
              "responses": {}
          },
          "parameters": [
              {
                  "schema": {
                      "type": "string"
                  },
                  "in": "header",
                  "name": "x-hasura-admin-secret",
                  "description": "Your x-hasura-admin-secret will be used for authentication of the API request."
              }
          ]
      }
  },
  "components": {}
}