# SeeR : Sense Evaluate Execute Report
Welcome, trailblazer! ๐
Get ready to unlock the full potential of your APIs with **SeeR** โ the intelligent platform that brings clarity and control to your API development and testing journey! ๐คฉ
## What is SeeR? ๐ค๐ก
SeeR is your ultimate API powerhouse! It's an all-in-one platform engineered to make managing, configuring, and rigorously testing your APIs an absolute breeze. ๐ฌ๏ธ
Simply import your OpenAPI (Swagger) 3.0 definition, and SeeR transforms it into a dynamic hub for comprehensive testing and deep insights. Gain unprecedented visibility and control โ SeeR is your API's personal clairvoyant! ๐ฎ
## SeeR's Core Power: Features That Define Excellence! ๐
SeeR supercharges your API workflow with groundbreaking capabilities:
* **Effortless API Integration** โฌ๏ธ\
Instantly import OpenAPI (Swagger) 3.0 specs. SeeR intelligently parses your definitions and validates server connectivity.
* **Dynamic Endpoint Control** โ๏ธ\
Fully customize API requests (Headers, Params, Body) and chain complex workflows with advanced Pre-requisite logic. Extract values and inject variables seamlessly.
* **Intelligent Automated Testing** ๐งช\
Generate multi-category tests โ Functional, Security ๐, Performance, Schema, and Error Handling โ with real-time Pass/Fail reports for maximum coverage.
* **Powerful Analytics & Reporting** ๐\
Access interactive dashboards, visual pass/fail trends ๐, and deep test drill-downs. Get actionable insights to enhance API performance.
## How to use SeeR? A Step-by-Step Guide! ๐๐บ๏ธ
Let's get you navigating SeeR like a pro! Follow these easy steps to harness its full power.
### Pre-requisites You'll Need ๐
Before you embark on your SeeR adventure, ensure you have:
* **An OpenAPI 3.0 Specification File:** This can be either a `.json` or `.yml` file. ๐
* **A Valid `servers` Section in Your OpenAPI File:** Your OpenAPI file **must** include a `servers` array with at least one `url` defined. This URL is super important for SeeR to connect to your API! For example:
```yaml
servers:
- url: https://api.yourcompany.com/v1
description: Production server
- url: http://localhost:8080/api
description: Local development server
```
โ ๏ธ Without a valid server URL, SeeR can't connect to your API!
### Your SeeR Journey: Step-by-Step ๐ฃ
SeeR takes you through a streamlined, multi-stage process โ from API setup to automated testing and deep-dive analysis.
Ready to begin? Your journey starts with configuring APIs โ upload your API specifications, customize endpoints, and connect your repositories.
## API Workflow Overview
๐ง Configure APIs
Upload your OpenAPI/Swagger spec, set parameters, and link repositories.\
๐ [Configure your APIs](/aiverse/seer/steps/config.md)
๐งช Run Automated Tests
Generate intelligent test cases and execute them seamlessly.\
๐ [Run automated tests](/aiverse/seer/steps/tests.md)
๐ Analyze Reports
Visualize results, identify issues, and optimize your API performance.\
๐ [Analyze test reports](https://github.com/QQyrus/ai-doc/blob/staging/seer/steps/reprts.md)
***
### ๐ Supercharge Your CI/CD: SeeR's `QAPI` Integration for Automated Impact Analysis!
Elevate your development workflow with continuous impact analysis. SeeR integrates with QAPI to automatically assess the impact of code changes on your APIs directly within your CI/CD pipeline. Get immediate feedback on every Pull Request, ensuring stability and performance.
* **For Python Projects:** Easily integrate SeeR's QAPI-based impact analysis into your GitHub Actions workflows. ๐ [Learn how to integrate QAPI for Python projects here!](/aiverse/seer/qapi/integrate-with-python-microservices.md)
* **For Java Projects:** Easily integrate SeeR's QAPI-based impact analysis into your GitHub Actions workflows. ๐ [Learn how to integrate QAPI for Java projects here!](/aiverse/seer/qapi/integrate-with-java-microservices.md)
***
## Q/A โ Frequently Asked Questions
**Q: What happens if my OpenAPI file has upload issues (e.g., missing `servers` URL)?**\
**A:** SeeR validates your file immediately. If any required components (like `servers`) are missing, SeeR provides specific error messages to guide corrections.
**Q: What OpenAPI version does SeeR support?**\
**A:** SeeR supports OpenAPI 3.0 specifications, enabling compatibility with modern API standards.
**Q: Can I change API configuration after automated testing, and are results saved?**\
**A:** API configuration cannot be modified post-test execution. However, all test results are saved automatically under the unique Agent name in sidebar chat.
**Q: How does SeeR handle API authentication methods like API keys or OAuth?**\
**A:** Use the `Headers` tab to configure API keys or bearer tokens. For OAuth and similar workflows, SeeR's Pre-requisite Chaining enables token retrieval and automatic injection into requests.
**Q: Can SeeR manage large and complex API specifications?**\
**A:** Yes. SeeR is optimized to handle large API specifications. Initial processing may take slightly longer, but full functionality is supported.
**Q: How can I quickly understand a failed test?**\
**A:** SeeR's reports provide detailed request and response logs, assertion errors, and an AI-generated status reason to help identify the root cause.
**Q: What are Assertions in SeeR?**\
**A:** Assertions are validation checks performed on API responses to verify expected behavior.
**Q: Why use Pre-requisite APIs?**\
**A:** They allow API call chaining. For instance, you can retrieve a login token in one call and reuse it in subsequent calls without manual input.
**Q: Does SeeR store actual API data?**\
**A:** SeeR only processes your API data during testing. Data is handled securely and not stored beyond its testing purpose.
**Q: What does "Sync: true" mean in a test report?**\
**A:** It indicates that the SeeR agent is connected to GitHub, and test results are synchronized with related code changes.
***
Weโre excited for you to experience the power of SeeR! ๐
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.qyrus.com/aiverse/seer.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.