api-compose 0.0.6

A Framework for orchestrating, asserting and reporting on API calls with templates

Installation

PyPI Package

pip install api-compose

Get Started

acp scaffold <your_project_name>

Run the programme

acp run

Examples

• Examples are in ./examples folder

Bullish API

Cat API

Features

API Call Composition

• Allows API calls to be declared as Models.

• Distinguishes between Compile Time Rendering and Run Time Rendering

• Leverages networkx to determine the execution order of each API call.

• Exposes CalculatedField as a hook for users to generate dynamic data for each API call.

• (Comimg soon) Auto-retry Scenario if not all Actions are in ENDED state.

Schema Validation

• Leverages jsonschema and xmlschema to validate returned json and xml data respectively.

Assertion

• Provides Basic means to make assertions between API Calls Result

  • Jinja Syntax

  • Python Syntax

Reporting

• Presents Test Results nicely in HTML reports

Architectural Diagram

The above is the API Testing Framwork Architecture.

Lucid Chart here: https://lucid.app/lucidchart/f8d1f9f9-bc93-46ec-8e4f-6561a4c822c3/edit?beaconFlowId=70D4EDD3B7971E6C&invitationId=inv_c7b45baf-050c-480b-923e-2979440ce4c8&page=0_0#

Hierarchical structure of the models

Lucid Chart here: https://lucid.app/lucidchart/f8d1f9f9-bc93-46ec-8e4f-6561a4c822c3/edit?beaconFlowId=70D4EDD3B7971E6C&invitationId=inv_c7b45baf-050c-480b-923e-2979440ce4c8&page=p0OVapsRWlkY#

Jinja Templating

Compile Time Rendering

• To make templates reusable, the programme exposes the means to render template files using the below syntax:

block_start_string='[%'
block_end_string='%]'
variable_start_string='[['
variable_end_string=']]'
comment_start_string='[#'
comment_end_string='#]'

Run Time Rendering

• To allow for inter-API Call dependencies within a given scenario, the programme also exposes the means to render templated fields using the below syntax:

block_start_string='{%'
block_end_string='%}'
variable_start_string='{{'
variable_end_string='}}'
comment_start_string='{#'
comment_end_string='#}'

Config File

File name is config.yaml

# Logging level for all loggers
LOGGING__LOGGING_LEVEL:  60

# When null, do not write log file. Else. write to log file
LOGGING__FILE_PATH: null

# When empty, do not filter logs based on events. Else, only filter for events in list
LOGGING__EVENT_FILTERS: []

# debug mode or not
is_interactive: False