Update README.md, Docs, and added function tests for proxy detection, collection path resolution, and proxy verification with requests.

Author: darmado

README.md

@@ -16,18 +16,14 @@ Postman2Burp bridges the gap between API development and security testing by aut
 
 ## 📋 Table of Contents
 
-- [Postman2Burp](#postman2burp)
-  - [📋 Table of Contents](#-table-of-contents)
-  - [🎯 Purpose](#-purpose)
-  - [🔮 Assumptions](#-assumptions)
-  - [📦 Requirements](#-requirements)
-  - [🚀 Quick Start](#-quick-start)
-  - [✨ Features](#-features)
-  - [🎯 Use Cases](#-use-cases)
-  - [⚠️ Limitations](#️-limitations)
-  - [📚 Documentation](#-documentation)
-  - [📜 License](#-license)
-  - [👥 Contributing](#-contributing)
+<div align="center">
+
+| [🎯 Purpose](#-purpose) | [🔮 Assumptions](#-assumptions) | [📦 Requirements](#-requirements) | [🚀 Quick Start](#-quick-start) |
+|:----------------------:|:------------------------------:|:--------------------------------:|:-------------------------------:|
+| [✨ Features](#-features) | [🎯 Use Cases](#-use-cases) | [⚠️ Limitations](#️-limitations) | [📚 Documentation](#-documentation) |
+| [🏆 Credits](#-credits) | [📜 License](#-license) | [👥 Contributing](#-contributing) | |
+
+</div>
 
 ## 🎯 Purpose
 
@@ -104,7 +100,7 @@ For complete examples with code samples and technical details, see our [Use Case
 
 ## 📚 Documentation
 
-Comprehensive documentation is available in the [Wiki](https://github.com/darmado/postman2burp/wiki):
+Documentation is available in the [Wiki](https://github.com/darmado/postman2burp/wiki):
 
 | Documentation | Description |
 |---------------|-------------|
@@ -115,6 +111,8 @@ Comprehensive documentation is available in the [Wiki](https://github.com/darmad
 | [Additional Features](https://github.com/darmado/postman2burp/wiki/Features) | Extended features and techniques |
 | [Configuration](https://github.com/darmado/postman2burp/wiki/Configuration) | Configuration options and settings |
 | [Troubleshooting](https://github.com/darmado/postman2burp/wiki/Troubleshooting) | Solutions for common issues |
+| [Function Map](https://github.com/darmado/postman2burp/wiki/Function-Map) | Overview of all functions and their roles |
+
 
 ## 📜 License
 

Wiki/Configuration/README.md

@@ -2,15 +2,17 @@
 
 This guide explains how to configure Postman2Burp using configuration files and command-line options.
 
-## Configuration File
+##
+
+### Configuration File
 
 Postman2Burp supports configuration via a `config.json` file, making it easier to maintain consistent settings across multiple runs.
 
-### Location
+***Location***
 
 The tool looks for a `config.json` file in the `config` directory. If found, it loads settings from this file.
 
-### Sample Configuration File
+***Sample Configuration File***
 
 ```json
 {
@@ -21,7 +23,7 @@ The tool looks for a `config.json` file in the `config` directory. If found, it
 }
 ```
 
-### Available Configuration Options
+***Available Configuration Options***
 
 | Option | Type | Description |
 |--------|------|-------------|
@@ -30,39 +32,45 @@ The tool looks for a `config.json` file in the `config` directory. If found, it
 | `verify_ssl` | Boolean | Whether to verify SSL certificates |
 | `skip_proxy_check` | Boolean | Whether to skip the proxy connection check |
 
-## Creating a Configuration File
+##
+
+### Creating a Configuration File
 
 You can create a configuration file in two ways:
 
-### 1. Manually
+***1. Manually***
 
 Create a `config.json` file in the `config` directory using the sample above.
 
-### 2. Automatically
+***2. Automatically***
 
 Run the script with your desired settings and add the `--save-config` flag:
 
 ```bash
 python postman2burp.py --collection your_collection.json --proxy-host your-proxy-host --proxy-port 9090 --save-config
 ```
 
-## Command-Line Priority
+##
+
+### Command-Line Priority
 
 Command-line arguments always take precedence over configuration file settings. This allows you to:
 
 1. Maintain default settings in the configuration file
 2. Override specific settings as needed for individual runs
 
-## Usage Examples
+##
 
-### Using Configuration File Only
+### Usage Examples
+
+***Using Configuration File Only***
 
 ```bash
 # Assuming config.json exists with your settings
 python postman2burp.py --collection your_collection.json
 ```
 
-### Overriding Configuration File
+***Overriding Configuration File***
 
 ```bash
 # Override proxy host from config file
@@ -72,18 +80,20 @@ python postman2burp.py --collection your_collection.json --proxy-host different-
 python postman2burp.py --collection your_collection.json --proxy-port 9090
 ```
 
-### Saving New Configuration
+***Saving New Configuration***
 
 ```bash
 # Save current settings to config.json
 python postman2burp.py --collection your_collection.json --proxy-host your-proxy --proxy-port 9090 --save-config
 ```
 
-## Environment Variables
+##
+
+### Environment Variables
 
 Postman2Burp also supports environment variables for configuration. These take precedence over the configuration file but are overridden by command-line arguments.
 
-### Supported Environment Variables
+***Supported Environment Variables***
 
 | Environment Variable | Description |
 |----------------------|-------------|
@@ -92,7 +102,7 @@ Postman2Burp also supports environment variables for configuration. These take p
 | `POSTMAN2BURP_VERIFY_SSL` | Set to "true" to verify SSL certificates |
 | `POSTMAN2BURP_SKIP_PROXY_CHECK` | Set to "true" to skip proxy check |
 
-### Example Usage
+***Example Usage***
 
 ```bash
 # Set environment variables
@@ -103,6 +113,8 @@ export POSTMAN2BURP_PROXY_PORT=8080
 python postman2burp.py --collection your_collection.json
 ```
 
-## Next Steps
+##
+
+### Next Steps
 
 - [[Troubleshooting]] 

Wiki/Features/README.md

@@ -1,8 +1,7 @@
-# Additional Features
 
-This guide covers additional features and techniques for getting the most out of Postman2Burp.
+##
 
-## Batch Processing
+### Batch Processing
 
 Process multiple collections at once using shell scripting:
 
@@ -11,30 +10,31 @@ for collection in ./collections/*.json; do
   python postman2burp.py --collection "$collection" --target-profile "your_profile.json"
 done
 ```
+##
 
-## Custom Proxy Configuration
+### Custom Proxy Configuration
 
-### Combined Host:Port Format
+**Combined Host:Port Format**
 
 ```bash
 python postman2burp.py --collection "your_collection.json" --proxy 127.0.0.1:8888
 ```
 
-### Separate Host and Port
+**Separate Host and Port**
 
 ```bash
 python postman2burp.py --collection "your_collection.json" --proxy-host 127.0.0.1 --proxy-port 8888
 ```
 
-## SSL Verification
+**SSL Verification**
 
 Enable SSL certificate verification (disabled by default):
 
 ```bash
 python postman2burp.py --collection "your_collection.json" --verify-ssl
 ```
 
-## Output Saving
+**Saving requests to a log file**
 
 Save request and response details to a JSON file for later analysis:
 
@@ -51,17 +51,19 @@ The output file contains an array of request/response pairs with details like:
 - Response body
 - Timing information
 
-## Configuration Management
+##
 
-### Saving Configuration
+### Configuration Management
+
+**Saving Configuration**
 
 Save your current settings to the config file for future use:
 
 ```bash
 python postman2burp.py --collection "your_collection.json" --proxy localhost:8080 --save-config
 ```
 
-### Loading Configuration
+**Loading Configuration**
 
 The tool automatically loads settings from `config.json` if it exists. You can override specific settings with command-line arguments:
 
@@ -70,9 +72,11 @@ The tool automatically loads settings from `config.json` if it exists. You can o
 python postman2burp.py --collection "different_collection.json"
 ```
 
-## CI/CD Integration
+## 
+
+### CI/CD Integration
 
-### Jenkins Pipeline Example
+**Jenkins Pipeline Example**
 
 ```groovy
 pipeline {
@@ -105,8 +109,9 @@ pipeline {
     }
 }
 ```
+##
 
-## Environment Variables
+### Environment Variables
 
 Use environment variables in your profile file:
 
@@ -129,7 +134,7 @@ export PASSWORD="your-password"
 python postman2burp.py --collection "your_collection.json" --target-profile "your_profile.json"
 ```
 
-## Handling Large Collections
+**Handling Large Collections**
 
 For large collections, you can:
 

Wiki/Function Map/README.md

@@ -0,0 +1,93 @@
+# Function Map
+
+This page provides a comprehensive overview of all functions in the Postman2Burp tool, organized by category. This map helps developers understand the codebase structure and the role of each function.
+
+## Core Functions
+
+| Function | Description | Return Type |
+|----------|-------------|-------------|
+| `validate_json_file(file_path)` | Validates if a file contains valid JSON and returns the parsed content | `Tuple[bool, Optional[Dict]]` |
+| `load_config()` | Loads configuration from the config file | `Dict` |
+| `save_config(config)` | Saves configuration to the config file | `bool` |
+| `resolve_collection_path(collection_path)` | Resolves the full path to a collection file | `str` |
+
+## Proxy Management
+
+| Function | Description | Return Type |
+|----------|-------------|-------------|
+| `check_proxy_connection(host, port)` | Checks if a proxy is running at the specified host and port using socket connection | `bool` |
+| `detect_running_proxy()` | Auto-detects running proxy by checking common proxy configurations | `Tuple[Optional[str], Optional[int]]` |
+| `verify_proxy_with_request(host, port)` | Verifies proxy by making a test HTTP request through it | `bool` |
+
+## Variable Management
+
+| Function | Description | Return Type |
+|----------|-------------|-------------|
+| `extract_variables_from_text(text)` | Extracts variables ({{variable}}) from text | `Set[str]` |
+| `extract_variables_from_collection(collection_path)` | Extracts all variables from a Postman collection | `Tuple[Set[str], Optional[str]]` |
+| `generate_variables_template(collection_path, output_path)` | Generates a template file with all variables from a collection | `None` |
+
+## PostmanToBurp Class Methods
+
+| Method | Description | Return Type |
+|--------|-------------|-------------|
+| `__init__(collection_path, ...)` | Initializes the PostmanToBurp object with configuration | `None` |
+| `load_collection()` | Loads and validates the Postman collection | `bool` |
+| `load_profile()` | Loads and validates the profile with variables | `bool` |
+| `replace_variables(text)` | Replaces variables in text with values from the profile | `str` |
+| `extract_requests_from_item(item, folder_name)` | Extracts requests from a collection item | `List[Dict]` |
+| `extract_all_requests(collection)` | Extracts all requests from the collection | `List[Dict]` |
+| `prepare_request(request_data)` | Prepares a request for sending (replaces variables, etc.) | `Dict` |
+| `send_request(prepared_request)` | Sends a request through the proxy | `Dict` |
+| `process_collection()` | Processes the entire collection | `None` |
+| `run()` | Runs the entire process and returns results | `Dict` |
+| `check_proxy()` | Checks if the proxy is running | `bool` |
+| `save_results()` | Saves results to the output file | `None` |
+
+## Helper Functions
+
+| Function | Description | Return Type |
+|----------|-------------|-------------|
+| `process_url(url)` | Processes URL to extract variables (internal) | `Set[str]` |
+| `process_body(body)` | Processes request body to extract variables (internal) | `Set[str]` |
+| `process_headers(headers)` | Processes headers to extract variables (internal) | `Set[str]` |
+| `process_request(request)` | Processes a request to extract variables (internal) | `Set[str]` |
+| `process_item(item)` | Processes a collection item to extract variables (internal) | `Set[str]` |
+
+## Main Function
+
+| Function | Description | Return Type |
+|----------|-------------|-------------|
+| `main()` | Entry point for the command-line interface | `None` |
+
+## Function Dependencies
+
+The following diagram shows the main function dependencies:
+
+```
+main()
+  ├── load_config()
+  │     └── validate_json_file()
+  ├── resolve_collection_path()
+  ├── PostmanToBurp.run()
+  │     ├── load_collection()
+  │     │     └── validate_json_file()
+  │     ├── load_profile()
+  │     │     └── validate_json_file()
+  │     ├── check_proxy()
+  │     │     ├── check_proxy_connection()
+  │     │     ├── detect_running_proxy()
+  │     │     └── verify_proxy_with_request()
+  │     ├── process_collection()
+  │     │     ├── extract_all_requests()
+  │     │     │     └── extract_requests_from_item()
+  │     │     ├── prepare_request()
+  │     │     │     └── replace_variables()
+  │     │     └── send_request()
+  │     └── save_results()
+  └── save_config()
+```
+
+## Testing Functions
+
+The test suite includes tests for all major functions to ensure they work correctly. See the [[Tests]] page for more information on the test suite.

Wiki/Overview.md renamed to Wiki/Overview/README.md

@@ -1,6 +1,4 @@
-# Overview
-
-## Introduction
+## Introducton
 
 Postman2Burp bridges the gap between API development and security testing by automatically sending Postman collection requests through Burp Suite proxy. The tool solves the critical problem of translating existing API test collections into security testing workflows without manual recreation of complex request sequences.