Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

About API Functional Monitoring

You can use API functional monitoring to run a test or suite of tests on an API. API functional monitoring is based on Blackbox Automated Testing (BAT).

Refer to the BAT demo for a substantial example of a BAT test suite. Clone the BAT demo at the following location:

https://github.com/mulesoft/bat-demo

Using API functional monitoring, you can automate testing and get test reports. You can test before pushing code into your repository and before deploying to production. Tests can verify API functionality and validate results the API generates. You can monitor APIs at each stage of the software development life cycle and in production.

The prerequisites for performing API functional testing and scheduling are:

  • Deployed API

    You can deploy an API on Anypoint Platform or your own server.

  • Installation of BAT.

  • A YAML configuration file (manifest file).

  • At least one test file.

    • You write files in Behavior Driven Development (BDD) syntax using a code or text editor, such as IntelliJ.

    • You save the files using the .dwl extension for processing by DataWeave.

Additional prerequisites for monitoring scheduled tests in the cloud are:

  • An account on Anypoint Platform.

  • A reporting tool supported by BAT.

BAT Playground

The BAT playground is a web application you can use to familiarize yourself with Behavior Driven Development (BDD) syntax. In the playground, you can run playground-provided tests or your own.

In this topic: