Add first work package for REST API implementation

[anna.git] / example / diameter / launcher / resources / rest_api / helpers / README

diff --git a/example/diameter/launcher/resources/rest_api/helpers/README b/example/diameter/launcher/resources/rest_api/helpers/README
new file mode 100644 (file)
index 0000000..133b2c0
--- /dev/null
+++ b/example/diameter/launcher/resources/rest_api/helpers/README
@@ -0,0 +1,14 @@
+1) Disect a pcap by mean the 'tsharkDecoder.sh' utility. For example:
+
+   ./tsharkDecoder.sh example.pcap
+
+2) Check the files created (metadata & hex) for every pcap frame.
+   The 'origin-hosts' file content all the Origin-Host names found in the pcap capture.
+
+3) Decode an hex file by mean the 'decodeHex.sh' script. For example:
+
+   ./decodeHex.sh 8.hex
+
+   This will create the corresponding diameter message representation in two formats:
+   3.1) xml format
+   3.2) json format (through diameterJsonHelper resources)