Module katt_blueprint_parse

KATT Blueprint parser.

Copyright © 2012- Klarna AB, AUTHORS

Description

KATT Blueprint parser

This is an interface module which provides access to the main functionality of katt_blueprint_parser, i.e. parsing a KATT Blueprint string or file.

Data Types

http_header()

http_header() = {string(), string()}

katt_blueprint()

katt_blueprint() = #katt_blueprint{filename = file:filename() | null, name = utf8_string() | null, description = utf8_string() | null, transactions = [#katt_transaction{description = utf8_string() | null, params = katt_transaction_params(), request = #katt_request{method = string(), url = string(), headers = [http_header()], body = binary() | null}, response = #katt_response{status = integer(), headers = [http_header()], body = binary() | null, parsed_body = any()}}], footer = utf8_string() | null}

katt_transaction_param_name()

katt_transaction_param_name() = string()

katt_transaction_param_value()

katt_transaction_param_value() = atom() | integer() | float() | string() | binary()

katt_transaction_params()

katt_transaction_params() = [{katt_transaction_param_name(), katt_transaction_param_value()}]

utf8_string()

utf8_string() = unicode:unicode_binary()

Function Index

file/1Parse a KATT Blueprint file.
string/1Parse a KATT Blueprint string.

Function Details

file/1

file(File::file:name()) -> {ok, katt_blueprint()}

Parse a KATT Blueprint file.

string/1

string(Str::string()) -> {ok, katt_blueprint()}

Parse a KATT Blueprint string.


Generated by EDoc