API Docs

Overview

API documentation is auto-generated for your schema definitions and is intended to provide an overview of the APIs Neurelo generates based on your data definition. It will go into detail on how to perform operations using these APIs using a sample schema as a reference. You can then apply these concepts and patterns to your own schema. Reference documentation generated specifically for your data definition is included in the API documentation.

Neurelo provides two types of APIs that are automatically generated and available for use.

• The REST API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

• The GraphQL API exposes a single endpoint where clients can send GraphQL queries or mutations and a strictly-typed schema that be be shared across consumers.

You can toggle between the GraphQL and REST API documentation above.

Reference - Neurelo Supported Databases

Exploring API Docs in Neurelo

Here is how you can access and navigate the Auto Generated API docs:

1. Viewing API Docs at the definitions level:

   • Step into your project from Neurelo's dashboard

   • Inside the project, select Definition from left navigation panel. This should open a new page with different definition components - Schema, Custom Query and API Docs

   • Click on API Docs on this screen. This will load a detailed API Doc on your screen.

   • By default, the page will load with RESTful API. You can select GraphQL API from the toggle button on this screen

   • The inner left navigation panel, provides all the different exploration options for this API endpoint set

   
2. Viewing API Docs at the definitions level:

   • Navigate into your project from Neurelo's dashboard

   • Inside the project, select Environments from the left navigation panel. This should open a new page that list all your Environments inside this project.

   • Select an environment. This will open up a detailed environment page. By default this page loads the APIs page.

   

   • From here, you can test any API using Neurelo's Playground feature. Click "Play" icon from the right side of the screen.

   • This will open a Playground page with all APIs listed in the left navigation panel. Select any API, enter the required information including the API Key and hit the Send button

   • The Playground should display the results or error accordingly.

   

While using Neurelo's API Playground, please have the environment specific API Key ready as Neurelo does not store your API Keys