mirror of
https://github.com/foss42/apidash.git
synced 2025-07-03 06:27:26 +08:00
Feat: Added Generate Test Cases and moved short prompting examples to another function
This commit is contained in:
@ -20,23 +20,52 @@ class OllamaService {
|
|||||||
// Explain latest API request & response
|
// Explain latest API request & response
|
||||||
Future<String> explainLatestApi({required dynamic requestModel, required dynamic responseModel}) async {
|
Future<String> explainLatestApi({required dynamic requestModel, required dynamic responseModel}) async {
|
||||||
if (requestModel == null || responseModel == null) {
|
if (requestModel == null || responseModel == null) {
|
||||||
return "There are no recent API Requests.";
|
return "No recent API requests found";
|
||||||
}
|
}
|
||||||
|
|
||||||
final requestJson = jsonEncode(requestModel.toJson());
|
// Extract request details
|
||||||
final responseJson = jsonEncode(responseModel.toJson());
|
final method = requestModel.httpRequestModel?.method
|
||||||
|
.toString()
|
||||||
|
.split('.')
|
||||||
|
.last
|
||||||
|
.toUpperCase()
|
||||||
|
?? "GET";
|
||||||
|
final endpoint = requestModel.httpRequestModel?.url ?? "Unknown endpoint";
|
||||||
|
final headers = requestModel.httpRequestModel?.enabledHeadersMap ?? {};
|
||||||
|
final parameters = requestModel.httpRequestModel?.enabledParamsMap ?? {};
|
||||||
|
final body = requestModel.httpRequestModel?.body;
|
||||||
|
|
||||||
|
// Process response
|
||||||
|
final rawResponse = responseModel.body;
|
||||||
|
final responseBody = rawResponse is String;
|
||||||
|
final statusCode = responseModel.statusCode ?? 0;
|
||||||
|
|
||||||
final prompt = '''
|
final prompt = '''
|
||||||
Explain the API request and response in a simple way:
|
Analyze this API interaction following these examples:
|
||||||
|
|
||||||
**Request Details:**
|
Current API Request:
|
||||||
$requestJson
|
- Endpoint: $endpoint
|
||||||
|
- Method: $method
|
||||||
|
- Headers: ${headers.isNotEmpty ? jsonEncode(headers) : "None"}
|
||||||
|
- Parameters: ${parameters.isNotEmpty ? jsonEncode(parameters) : "None"}
|
||||||
|
- Body: ${body ?? "None"}
|
||||||
|
|
||||||
**Response Details:**
|
Current Response:
|
||||||
$responseJson
|
- Status Code: $statusCode
|
||||||
|
- Response Body: ${jsonEncode(responseBody)}
|
||||||
|
|
||||||
|
Required Analysis Format:
|
||||||
|
1. Start with overall status assessment
|
||||||
|
2. List validation/security issues
|
||||||
|
3. Highlight request/response mismatches
|
||||||
|
4. Suggest concrete improvements
|
||||||
|
5. Use plain text formatting with clear section headers
|
||||||
|
|
||||||
|
Response Structure:
|
||||||
|
API Request: [request details]
|
||||||
|
Response: [response details]
|
||||||
|
Analysis: [structured analysis]''';
|
||||||
|
|
||||||
Please provide a brief and clear explanation with key insights.
|
|
||||||
''';
|
|
||||||
return generateResponse(prompt);
|
return generateResponse(prompt);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -70,4 +99,103 @@ class OllamaService {
|
|||||||
|
|
||||||
return generateResponse(prompt);
|
return generateResponse(prompt);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Future<String> generateTestCases({required dynamic requestModel, required dynamic responseModel}) async {
|
||||||
|
|
||||||
|
final method = requestModel.httpRequestModel?.method
|
||||||
|
.toString()
|
||||||
|
.split('.')
|
||||||
|
.last
|
||||||
|
.toUpperCase()
|
||||||
|
?? "GET";
|
||||||
|
final endpoint = requestModel.httpRequestModel?.url ?? "Unknown endpoint";
|
||||||
|
final headers = requestModel.httpRequestModel?.enabledHeadersMap ?? {};
|
||||||
|
final parameters = requestModel.httpRequestModel?.enabledParamsMap ?? {};
|
||||||
|
final body = requestModel.httpRequestModel?.body;
|
||||||
|
final exampleParams = await generateExampleParams(
|
||||||
|
requestModel: requestModel,
|
||||||
|
responseModel: responseModel,
|
||||||
|
);
|
||||||
|
final prompt = '''
|
||||||
|
Generate test cases for the following API:
|
||||||
|
|
||||||
|
**API Request:**
|
||||||
|
- **Endpoint:** `$endpoint`
|
||||||
|
- **Method:** `$method`
|
||||||
|
- **Headers:** ${headers.isNotEmpty ? jsonEncode(headers) : "None"}
|
||||||
|
- **Parameters:** ${parameters.isNotEmpty ? jsonEncode(parameters) : "None"}
|
||||||
|
|
||||||
|
**Test Case Requirements:**
|
||||||
|
1. Normal case (valid input, expected success)
|
||||||
|
2. Edge case (unexpected or boundary values)
|
||||||
|
3. Missing required parameters
|
||||||
|
4. Invalid authentication (if applicable)
|
||||||
|
5. Error handling for different status codes
|
||||||
|
|
||||||
|
**Example Test Case Format:**
|
||||||
|
@Test
|
||||||
|
void testValidRequest() {
|
||||||
|
final response = sendRequest("$endpoint", method: "$method", params: $exampleParams);
|
||||||
|
assert(response.status == 200);
|
||||||
|
}
|
||||||
|
\`\`\`
|
||||||
|
|
||||||
|
Generate test cases covering all scenarios.
|
||||||
|
''';
|
||||||
|
|
||||||
|
return generateResponse(prompt);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Generate example parameter values based on parameter names
|
||||||
|
Future<Map<String, dynamic>> generateExampleParams({required dynamic requestModel, required dynamic responseModel,}) async {
|
||||||
|
final ollamaService = OllamaService();
|
||||||
|
|
||||||
|
final method = requestModel.httpRequestModel?.method
|
||||||
|
.toString()
|
||||||
|
.split('.')
|
||||||
|
.last
|
||||||
|
.toUpperCase()
|
||||||
|
?? "GET";
|
||||||
|
final endpoint = requestModel.httpRequestModel?.url ?? "Unknown endpoint";
|
||||||
|
final headers = requestModel.httpRequestModel?.enabledHeadersMap ?? {};
|
||||||
|
final parameters = requestModel.httpRequestModel?.enabledParamsMap ?? {};
|
||||||
|
final body = requestModel.httpRequestModel?.body;
|
||||||
|
|
||||||
|
|
||||||
|
final dynamic rawResponse = responseModel?.body;
|
||||||
|
final Map<String, dynamic>? apiResponse =
|
||||||
|
(rawResponse is String) ? jsonDecode(rawResponse) : rawResponse is Map<String, dynamic> ? rawResponse : null;
|
||||||
|
|
||||||
|
// Construct LLM prompt to analyze and extract meaningful test cases
|
||||||
|
final String prompt = '''
|
||||||
|
Analyze the following API request and generate structured example parameters.
|
||||||
|
|
||||||
|
**API Request:**
|
||||||
|
- **Endpoint:** `$endpoint`
|
||||||
|
- **Method:** `$method`
|
||||||
|
- **Headers:** ${headers.isNotEmpty ? jsonEncode(headers) : "None"}
|
||||||
|
- **Parameters:** ${parameters.isNotEmpty ? jsonEncode(parameters) : "None"}
|
||||||
|
- **Body:** ${body ?? "None"}
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
- **Status Code:** ${responseModel?.statusCode ?? "Unknown"}
|
||||||
|
- **Response Body:** ${apiResponse != null ? jsonEncode(apiResponse) : rawResponse}
|
||||||
|
|
||||||
|
### **Required Output Format**
|
||||||
|
1. **Standard Example Values**: Assign the most appropriate example values for each parameter.
|
||||||
|
2. **Edge Cases**: Provide at least 2 edge cases per parameter.
|
||||||
|
3. **Invalid Cases**: Generate invalid inputs for error handling.
|
||||||
|
4. **Output must be in valid JSON format.**
|
||||||
|
''';
|
||||||
|
|
||||||
|
// Force LLM to return structured JSON output
|
||||||
|
final String response = await ollamaService.generateResponse(prompt);
|
||||||
|
|
||||||
|
try {
|
||||||
|
return jsonDecode(response) as Map<String, dynamic>;
|
||||||
|
} catch (e) {
|
||||||
|
return {"error": "Failed to parse response from LLM."};
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -38,6 +38,11 @@ class _ChatbotWidgetState extends ConsumerState<ChatbotWidget> {
|
|||||||
requestModel: requestModel,
|
requestModel: requestModel,
|
||||||
responseModel: responseModel,
|
responseModel: responseModel,
|
||||||
);
|
);
|
||||||
|
} else if (message == "Generate Test Case") {
|
||||||
|
response = await ollamaService.generateTestCases(
|
||||||
|
requestModel: requestModel,
|
||||||
|
responseModel: responseModel
|
||||||
|
);
|
||||||
} else {
|
} else {
|
||||||
response = await ollamaService.generateResponse(message);
|
response = await ollamaService.generateResponse(message);
|
||||||
}
|
}
|
||||||
@ -91,6 +96,17 @@ class _ChatbotWidgetState extends ConsumerState<ChatbotWidget> {
|
|||||||
),
|
),
|
||||||
],
|
],
|
||||||
const Spacer(),
|
const Spacer(),
|
||||||
|
const SizedBox(width: 8),
|
||||||
|
ElevatedButton.icon(
|
||||||
|
onPressed: () => _sendMessage("Generate Test Case"),
|
||||||
|
icon: const Icon(Icons.developer_mode),
|
||||||
|
label: const Text("Test Case"),
|
||||||
|
style: ElevatedButton.styleFrom(
|
||||||
|
backgroundColor: Colors.blueAccent,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
|
||||||
|
const Spacer(),
|
||||||
],
|
],
|
||||||
),
|
),
|
||||||
Expanded(
|
Expanded(
|
||||||
|
Reference in New Issue
Block a user