Skip to main content

Onboard a GraphQL API


Prerequisites​

APIsec platform requires the following two prerequisites for GraphQL onboarding:

  • SDL file – Schema Definition Language file that describes the GraphQL schema.

  • Instance URL – The GraphQL endpoint URL where queries and mutations will be executed.


Start Adding GraphQL application​

Select GraphQL​

  • Choose the GraphQL option.

    GraphQL option in the application type selection

Enter application details​

  • Enter the Name.

    Name field in the application form

  • Click Browse files and upload a valid SDL file.

    Browse files option for uploading the SDL file

  • Click Continue.

    Continue button

  • Enter the Instance URL.

    Instance URL field

  • Click Onboard.

    Onboard button

  • The GraphQL application dashboard is displayed.

    GraphQL application dashboard

Edit Query or Edit Mutation​

  • Click the query you want to edit.

    Query selected in the endpoint list

  • Click Edit Query.

    Edit Query button

  • Enter the Variables Values.

    Variables Values fields

  • Click Update.

    Update button

  • The updated Variables Values appear in the Parameters Configuration table.

    Updated variable values in the Parameters Configuration table