https://github.com/jimmyislive/tapi

Framework for Testing APIs
https://github.com/jimmyislive/tapi

rest-api testing

Last synced: about 2 months ago
JSON representation

Framework for Testing APIs

• Host: GitHub
• URL: https://github.com/jimmyislive/tapi
• Owner: jimmyislive
• Created: 2014-01-05T22:43:41.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-07-03T03:12:42.000Z (almost 12 years ago)
• Last Synced: 2023-03-24T10:45:16.270Z (about 3 years ago)
• Topics: rest-api, testing
• Language: Python
• Homepage: http://tapi.readthedocs.org/en/latest/index.html
• Size: 877 KB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/jimmyislive/tapi.png?branch=master)](https://travis-ci.org/jimmyislive/tapi)

# TAPI - Testing APIs

Tapi is a framework for testing APIs

## Features

1. Test you API without writing any code (only edit a json file)

2. Test you APIs in a much more 'natural' way by specifying urls/verbs and what the output should be

3. Verify anything from response status codes, headers, body content etc

4. Also allows verification by issuing another API call to a different endpoint to ensure a prior API call worked

5. Execute arbitrary python scripts to populate request paramaters e.g. custom headers

6. Execute arbitrary python scripts to verify response from endpoint is valid

7. Tests your APIs using your own APIs

## Documentation

Documentation is available at http://tapi.readthedocs.org/en/latest/#

## Installation

pip install tapi

## Quickstart

In order to start using Tapi you have to write a tapi.json file. The simplest tapi.json file looks like:

```

    {

        "tests": [

            {

                "main": {

                    "request": {

                        "url": "http://api.example.com/users"

                    }

                }

            }

        ]

    }

```

The above means the following:

1. There is one test in this file

2. The framework will make a GET (the default) request to the endpoint api.example.com/users

3. The framework will verify that the return status code is 200 (default)

You can run this test by doing:

    python tapi.py

Thus, without writing a single line of code, you have successfully verfied that this endpoint works.

## TODO

1. Improve / Add more unit tests

2. Ability to split tapi.json into multiple files