mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-21 06:21:39 +03:00
132 lines
2.8 KiB
ReStructuredText
132 lines
2.8 KiB
ReStructuredText
.. meta::
|
|
:description: Manage RESTified endpoints with the Hasura schema/metadata API
|
|
:keywords: hasura, docs, restified-endpoints/metadata API, API reference, RESTified endpoints
|
|
|
|
.. _api_restified_endpoints:
|
|
|
|
Schema/Metadata API Reference: RESTified GraphQL Endpoints
|
|
==========================================================
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
Introduction
|
|
------------
|
|
|
|
Add/Remove a RESTified GraphQL endpoint to Hasura GraphQL engine.
|
|
|
|
.. admonition:: Deprecation
|
|
|
|
In versions ``v2.0.0`` and above, the schema/metadata API is deprecated in favour of the :ref:`schema API <schema_apis>` and the
|
|
:ref:`metadata API <metadata_apis>`.
|
|
|
|
Though for backwards compatibility, the schema/metadata APIs will continue to function.
|
|
|
|
.. _create_rest_endpoint:
|
|
|
|
create_rest_endpoint
|
|
--------------------
|
|
|
|
``create_rest_endpoint`` is used to associate a URL template with a query.
|
|
|
|
An example request as follows:
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type": "create_rest_endpoint",
|
|
"args": {
|
|
"name": "example-name",
|
|
"url": "example",
|
|
"methods": ["POST","PUT","PATCH"],
|
|
"definition": {
|
|
"query": {
|
|
"query_name": "example_mutation",
|
|
"collection_name": "test_collection"
|
|
}
|
|
},
|
|
"comment": "some optional comment"
|
|
}
|
|
}
|
|
|
|
|
|
.. _create_rest_endpoint_syntax:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - name
|
|
- true
|
|
- Text
|
|
- A unique identifier for the endpoint
|
|
* - url
|
|
- true
|
|
- :ref:`EndpointUrl`
|
|
- URL of the REST endpoint
|
|
* - methods
|
|
- true
|
|
- :ref:`EndpointMethods`
|
|
- Non-Empty case sensitive list of supported HTTP Methods
|
|
* - definition
|
|
- true
|
|
- :ref:`EndpointDef`
|
|
- Definition for the REST endpoint
|
|
* - comment
|
|
- false
|
|
- Text
|
|
- comment
|
|
|
|
.. admonition:: Supported from
|
|
|
|
RESTified endpoints are supported from versions ``v2.0.0-alpha.1`` and above.
|
|
|
|
.. _drop_rest_endpoint:
|
|
|
|
drop_rest_endpoint
|
|
------------------
|
|
|
|
``drop_rest_endpoint`` is used to delete an existing RESTified GraphQL Endpoint.
|
|
|
|
An example request as follows:
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type": "drop_rest_endpoint",
|
|
"args": {
|
|
"name": "name_of_the_endpoint"
|
|
}
|
|
}
|
|
|
|
.. _drop_rest_endpoint_syntax:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - name
|
|
- true
|
|
- Text
|
|
- URL of the RESTified endpoint
|
|
|
|
.. admonition:: Supported from
|
|
|
|
RESTified endpoints are supported from versions ``v2.0.0-alpha.1`` and above.
|