vue-api-request-builder 0.2.5 → 0.2.6

package/README.md

@@ -5,6 +5,30 @@ A Vue 3 component for building and testing API requests with a beautiful UI.
 # Start of Selection
 [中文文档](README_zh.md)
 
+## Workflow
+
+```mermaid
+graph TD
+    A[Start] --> B[Configure Request]
+    B --> C[RequestForm Component]
+    C --> D[Set Request Parameters]
+    D --> E[URL/Path]
+    D --> F[Authentication]
+    D --> G[Headers]
+    D --> H[Request Body]
+    E & F & G & H --> I[Execute Request]
+    I --> J[ResponseSection Component]
+    J --> K[Display Response]
+    K --> L[Status Code]
+    K --> M[Response Headers]
+    K --> N[Response Body]
+    L & M & N --> O[Data Transformation]
+    O --> P[DataTransform Component]
+    P --> Q[Transform Function]
+    Q --> R[Transformed Result]
+    R --> S[End]
+```
+
 ## Installation
 
 ```bash
@@ -82,6 +106,19 @@ Displays the response from the API request.
   - Response body with formatting
 - Error handling and display
 
+### DataTransform
+
+Component for configuring and executing data transformation functions.
+
+#### Props
+- `modelValue` (string): The transformation function string (v-model)
+
+#### Features
+- Code editor interface
+- JavaScript function support
+- Real-time syntax checking
+- Function execution preview
+
 ### KeyValueInput
 
 A reusable component for managing key-value pairs.
@@ -157,6 +194,17 @@ function executeRequest(
 
 Executes the API request using either Fetch API or XMLHttpRequest.
 
+### executeTransformFunction
+
+```typescript
+function executeTransformFunction(
+  transformFunctionString: string,
+  data: any
+): any
+```
+
+Executes a data transformation function to convert input data into the desired format.
+
 ## Dependencies
 
 This package requires: