Tooling Resources

Prerequisite

  • Install Postman to run postman testing

Postman resources

Postman is a widely-used collaboration platform for API development and testing. Using this third-party tool, you can easily test APIs with environments generated for your test platforms and imported testing collections of API queries.

Postman collections are comprised of REST, Document, or GraphQL schema and queries to run or test against one or more defined environments. The tool includes a collection runner testing utility for testing against query assertions embedded in the collection. Collections and environments can be imported or exported with Postman.

For Stargate development, three collections that correspond to the documentation code examples are available:

Each collection lets you try out creation, insertion, and deletion of both data and schema, as required.

To use the collections, you’ll need to download and configure a postman environment. Two environments are also available, one for the open-source Stargate docker image and one for DataStax Astra. A small amount of configuration is necessary in the single environment to set your parameters before use.

Postman environment configuration

Stargate OSS

If you are using non-standard ports, you’ll need to change them in the Postman environment. You can also edit the JSON file directly, if you prefer.

Astra

There are three items that must be retrieved from the Astra dashboard and configured in the Postman environment:

  • ASTRA_DB_ID

  • ASTRA_DB_REGION

  • ASTRA_DB_APPLICATION_TOKEN

Open the environment in Postman and copy/paste in the appropriate values. You can also edit the JSON file directly, if you prefer.