The Developer Flow: New Command-Line Tools for Developers & Automation Engineers!

API Fortress is excited to introduce a number of features specifically designed to enhance the flexibility of our enterprise API testing platform. New features specifically built to unlock the platform for developer teams that want to use their existing tools and processes. We call this The Developer Flow.

Optional: Import/Export

The first feature to discuss in the scope of our developer flow is test exporting and importing. This is useful for existing customers that have already created a lot of API Fortress tests. Multiple tests can be selected and added to a downloadable archive. Once the tests are downloaded, they can be edited in the IDE of your choice and uploaded back to the platform.

Export / Import

Export / Import

APIF Command-Line

Next, a developer could choose to skip the first step in the above workflow entirely. A test could be written from scratch in an IDE and then uploaded to API Fortress via the same method (the Upload Tests button.) But what if we wanted to accomplish this without accessing the tool at all? Enter the API Fortress command-line tool (named APIF-Auto).

APIF-Auto is a Python based command-line tool that wraps the API Fortress REST API. The tool (or rather, pair of tools) allow for the execution of tests and the pushing of test code to the platform from outside the platform itself. With the tool, a developer could write the test alongside the code that defines the API itself, push the code to the platform, and execute the test from the command-line, all without ever accessing the API Fortress GUI.

Command-line Tool

Command-line Tool

Version Control with Git

Finally, we come to version control. Previously, tests in API Fortress could be copied out of the platform and placed in a version control repository, but there was no way to explicitly link the code in the repository to the code in the platform. API Fortress has introduced a post-receive hook for Git that allows for a linking between the test code in a Git repository and the test code in the API Fortress platform.

Git Versioning

Git Versioning

The Developer Flow

When tied together, these new features paint an exciting picture of how enterprises can get more from API Fortress. An example developer workflow would be as follows:

  1. The developer writes the test code in their IDE for use in API Fortress.
  2. The test code is maintained in a Git repository alongside the API code.
  3. The test code is pushed to the API Fortress platform for execution via the command-line tool.
  4. The test is executed from the IDE or terminal with the command-line tool, returning verbose test results from API Fortress that can be viewed in the terminal, or output to a file in multiple different formats.

One of the most exciting parts about this feature-set is how it ties the roles of developer and tester together in the API Fortress workflow. Once the developer has written the test code, tied it to version control, and pushed it to the platform; the tester will always have an updated test to run against the API itself. With every version control commit, the post-receive hook pushes the updated copy of the test code to the platform. These new updates not only provide a more familiar environment for developers to interact with API Fortress in, but a deeper sense of collaboration between the development and testing teams. Furthermore, they provide increased visibility and stronger enterprise integrations with other tools.