test-your-api.html

---
layout: page
title: Test Your API
permalink: /developers/test-your-api
---

<h2>Testing Made Easy</h2>
<p>Unit Tests are absolutely crucial to ensuring that your API doesn’t have any backwards compatibility breaks and meets all of your current requirements.  With RAML you’re able to describe your HTTP REST API in such a way that it’s possible to generate many of those tests for you!!!</p>

<p>This means that after defining your spec, you’re able to take advantage of TDD (Test Driven Development) and have automatically generated tests in your CI (Continuous Integration) environments.</p>

<h2>Popular Testing Tools</h2>

<p>There are several tools that you can use to generate tests with RAML, including many available for free in the community, and other far more extensive testing services offered through companies such as API Science and SmartBear.</p>

<h3>Abao</h3>
<p>Abao is a NodeJS command-line tool for testing API documentation written in RAML format against its backend implementation. With Abao you can easily plug your API documentation into the Continuous Integration system like Travis CI or Jenkins and have API documentation up-to-date, all the time. Abao uses Mocha (http://mochajs.org/) for judging if a particular API response is valid or if is not.</p>

<p><a href="/projects#q:abao" class="button info">More Info</a> <a href="https://github.com/cybertk/abao/" class="button" target="_blank">Download</a></p>
<br />
<h3>Vigia</h3>
<p>Vigia is an adaptable API integration test suite which supports test generation based on a RAML definition file.</p>

<p><a href="/projects#q:vigia" class="button info">More Info</a> <a href="https://github.com/nogates/vigia" class="button" target="_blank">Download</a></p>
<br />
<h3>Postman</h3>
<p>Postman is one of the most popular API calling and testing tools used by developers today.  Freely available as a Chrome app, Postman supports API calls to any RESTful API and lets you setup scripts and tests after importing your RAML spec.</p>

<p><a href="/projects#q:postman" class="button info">More Info</a> <a href="http://www.getpostman.com" class="button" target="_blank">Download</a></p>
<br />
<h2>Popular Testing Services</h2>

<h3>API Fortress</h3>
<p>API Fortress provides testing by checking latency and response speeds within your API.  With API Fortress you can also validate responses and payloads to ensure that whether in dev or production your API is functioning correctly.  On top their services, API Fortress offers their own API - letting you test your API on demand.</p>

<p><a href="http://apifortress.com/" class="button info" target="_blank">Visit Website</a></p>
<br />
<h3>API Science</h3>

<p>API Science offers worldwide monitoring and testing of your API to identify performance issues, outages, errors.  With API Science you’re able to test multiple aspects of your HTTP based REST API including JSON, OAuth, and XML.  You can even test real, advanced CRUD sequences in production and receive alerts via Slack, PagerDuty, or via web hooks.</p>

<p><a href="http://www.apiscience.com" class="button info" target="_blank">Visit Website</a></p>
<br />
<h3>SmartBear</h3>
<p>SmartBear offers a large suite of testing tools for your API, letting you pull in your RAML spec to identify latency/ speed issues, errors, and verify response data.  Along with API Readiness tools, they also offer API Virtualization, Continuous Integration tooling, and Performance testing.<p>

<p><a href="http://smartbear.com/" class="button info" target="_blank">Visit Website</a></p>