API Docs

TableX leverages the power of MetaX to automatically generate RESTfull and GraphQL well documented API endpoints for your database.

There is no extra steps needed to be done by you, it works out of the box 🚀.

Usage

By default, MetaX listens on port 5522, you can view and try the API by different ways.

From the Terminal

REST API

REST endpoint request example

curl https://localhost:5522/tables

GraphQL API

GraphQL query request example

curl -X POST -H "Content-Type: application/json" -d '{"query": "{ tables }"}' http://localhost:5522/graphql

From The Browser

REST API

Navigate to http://localhost:5522/swagger where your will find the swagger documentation of the API where you can also test the endpoints.

GraphQL API

Navigate to http://localhost:5522/playground where you will find the Apollo Sandbox, an interactive interface where you can try graphql queries.

Tip

You can quickly open the Swagger documentation or the Apollo Sandbox from right withing TableX.

1. Open the Command Palette ( Ctrl+p ).
2. Select Show API docs option.
3. You will find options to navigate to the urls in your browser or copy the endpoint link to your clipboard.

Tip

The GraphQL schema is introspectable, meaning that you can provide the query endpoint to the API testing tool of your choice (e.g Postman) and it will automatically pull the types from the schema.