Search Blogs
QodexAI Platform Documentation
Getting Started with Qodex.ai
Let’s make your API testing journey smooth and effective. Here's your complete guide to everything Qodex.ai can do for you.
Getting Your APIs Into Qodex.ai
Head to the Collections tab, click on + (Add Collection) to add your API collection. You can add collections in these ways:
Postman Exports: You can directly import your postman export into you qodex.ai platform.
Swagger Exports: You can import your swagger.yaml or swagger.json file to get your api collection in the qodex.ai. You can also use our sdk link to generate a swagger document.
Export from logs: You can use our rails sdk link or nodejs sdk <link> to build your api collection directly from your application logs.
Generate Swagger from our SDK: you can generate swagger from your codebase using our open-source SDK link
Let’s make your API testing journey smooth and effective. Here's your complete guide to everything Qodex.ai can do for you.
Getting Your APIs Into Qodex.ai
Head to the Collections tab, click on + (Add Collection) to add your API collection. You can add collections in these ways:
Postman Exports: You can directly import your postman export into you qodex.ai platform.
Swagger Exports: You can import your swagger.yaml or swagger.json file to get your api collection in the qodex.ai. You can also use our sdk link to generate a swagger document.
Export from logs: You can use our rails sdk link or nodejs sdk <link> to build your api collection directly from your application logs.
Generate Swagger from our SDK: you can generate swagger from your codebase using our open-source SDK link
Let’s make your API testing journey smooth and effective. Here's your complete guide to everything Qodex.ai can do for you.
Getting Your APIs Into Qodex.ai
Head to the Collections tab, click on + (Add Collection) to add your API collection. You can add collections in these ways:
Postman Exports: You can directly import your postman export into you qodex.ai platform.
Swagger Exports: You can import your swagger.yaml or swagger.json file to get your api collection in the qodex.ai. You can also use our sdk link to generate a swagger document.
Export from logs: You can use our rails sdk link or nodejs sdk <link> to build your api collection directly from your application logs.
Generate Swagger from our SDK: you can generate swagger from your codebase using our open-source SDK link
Creating Your Tests
Head to API Testing > Test Scenarios and click "Add New Test Scenario".
There are two ways you can write tests:
Create with AI
Our customized AI model analyzes your API collection (imported above) and product doc to generate test scenarios. You can create one scenario or multiple and also review and modify these scenarios as needed.
I recommend checking out our guide API Testing with AI in 10 minutes to learn more.
Create Manually
You can always build scenarios yourself. You will need to :
Add a test scenario title
Create a test case, add a title and select a collection and API
Go to the request data section and add URLs, params or body whatever is required.
Hit Save to get the response corresponding to the request data
Go to test rules section and add test rules - either pick from our suggestions or write them in plain English (qodex.ai will convert it to JavaScript)
You can create on Run and select an environment to run this test scenario
You can go to build section to see the build corresponding to this run
Head to API Testing > Test Scenarios and click "Add New Test Scenario".
There are two ways you can write tests:
Create with AI
Our customized AI model analyzes your API collection (imported above) and product doc to generate test scenarios. You can create one scenario or multiple and also review and modify these scenarios as needed.
I recommend checking out our guide API Testing with AI in 10 minutes to learn more.
Create Manually
You can always build scenarios yourself. You will need to :
Add a test scenario title
Create a test case, add a title and select a collection and API
Go to the request data section and add URLs, params or body whatever is required.
Hit Save to get the response corresponding to the request data
Go to test rules section and add test rules - either pick from our suggestions or write them in plain English (qodex.ai will convert it to JavaScript)
You can create on Run and select an environment to run this test scenario
You can go to build section to see the build corresponding to this run
Head to API Testing > Test Scenarios and click "Add New Test Scenario".
There are two ways you can write tests:
Create with AI
Our customized AI model analyzes your API collection (imported above) and product doc to generate test scenarios. You can create one scenario or multiple and also review and modify these scenarios as needed.
I recommend checking out our guide API Testing with AI in 10 minutes to learn more.
Create Manually
You can always build scenarios yourself. You will need to :
Add a test scenario title
Create a test case, add a title and select a collection and API
Go to the request data section and add URLs, params or body whatever is required.
Hit Save to get the response corresponding to the request data
Go to test rules section and add test rules - either pick from our suggestions or write them in plain English (qodex.ai will convert it to JavaScript)
You can create on Run and select an environment to run this test scenario
You can go to build section to see the build corresponding to this run
Ship bug-free software, 200% faster, in 20% testing budget. No coding required
Ship bug-free software, 200% faster, in 20% testing budget. No coding required
Ship bug-free software, 200% faster, in 20% testing budget. No coding required
Organizing Your Tests
Test Suites
You can group your related test scenarios into Test Suites. Select specific test scenarios and use the "+Create/Add to Test Suite" to either create a new suite or add to an existing one. These suites let you run multiple test scenarios together when needed.
Test Plans
You can combine your test suites and handle their automated execution. Select your test suites and add them to a plan through the "Create/Add to Test Plan" button. In the plan details you can specify:
How often your tests should run
Set start and end times for the testing period
Configure notification settings
Who receives them (Ensure the right team members know about test results)
How they are delivered (Slack, email, etc..,.)
Running Tests
Run tests using your IDE, CLI, or Qodex.ai platform:
Automated scheduled run:
CI/CD Run:
Manual Run:
When tests fail, you'll see what went wrong and steps to fix it.
Test Suites
You can group your related test scenarios into Test Suites. Select specific test scenarios and use the "+Create/Add to Test Suite" to either create a new suite or add to an existing one. These suites let you run multiple test scenarios together when needed.
Test Plans
You can combine your test suites and handle their automated execution. Select your test suites and add them to a plan through the "Create/Add to Test Plan" button. In the plan details you can specify:
How often your tests should run
Set start and end times for the testing period
Configure notification settings
Who receives them (Ensure the right team members know about test results)
How they are delivered (Slack, email, etc..,.)
Running Tests
Run tests using your IDE, CLI, or Qodex.ai platform:
Automated scheduled run:
CI/CD Run:
Manual Run:
When tests fail, you'll see what went wrong and steps to fix it.
Test Suites
You can group your related test scenarios into Test Suites. Select specific test scenarios and use the "+Create/Add to Test Suite" to either create a new suite or add to an existing one. These suites let you run multiple test scenarios together when needed.
Test Plans
You can combine your test suites and handle their automated execution. Select your test suites and add them to a plan through the "Create/Add to Test Plan" button. In the plan details you can specify:
How often your tests should run
Set start and end times for the testing period
Configure notification settings
Who receives them (Ensure the right team members know about test results)
How they are delivered (Slack, email, etc..,.)
Running Tests
Run tests using your IDE, CLI, or Qodex.ai platform:
Automated scheduled run:
CI/CD Run:
Manual Run:
When tests fail, you'll see what went wrong and steps to fix it.
Keeping Track of Everything
Dashboard
Your dashboard provides comprehensive visibility into your testing operations.
Test coverage - Percentage of API under testing with enough test scenarios.
Tests Automated - Number of test scenarios running autonomously.
Success rate - Percentage of passing tests.
Cost savings - Financial benefits gained through automated vs manual testing (approx).
Three charts display:
Test distribution across systems
Test execution times
Types of tests in use
Check metrics anytime to track performance and make testing decisions.
Monitoring
You can track you API health in real-time. Set up monitoring sections by department or micro-service, create specific alert conditions, and define notification rules for when issues occur. The system will automatically notify relevant team members based on your configured escalation rules.
Build Reports
You can access detailed information about all test executions. View results of individual tests, performance data for test suites, and outcomes of scheduled test plans. The reporting system clearly identifies where issues occur in your testing workflow, helping you with troubleshooting.
Dashboard
Your dashboard provides comprehensive visibility into your testing operations.
Test coverage - Percentage of API under testing with enough test scenarios.
Tests Automated - Number of test scenarios running autonomously.
Success rate - Percentage of passing tests.
Cost savings - Financial benefits gained through automated vs manual testing (approx).
Three charts display:
Test distribution across systems
Test execution times
Types of tests in use
Check metrics anytime to track performance and make testing decisions.
Monitoring
You can track you API health in real-time. Set up monitoring sections by department or micro-service, create specific alert conditions, and define notification rules for when issues occur. The system will automatically notify relevant team members based on your configured escalation rules.
Build Reports
You can access detailed information about all test executions. View results of individual tests, performance data for test suites, and outcomes of scheduled test plans. The reporting system clearly identifies where issues occur in your testing workflow, helping you with troubleshooting.
Dashboard
Your dashboard provides comprehensive visibility into your testing operations.
Test coverage - Percentage of API under testing with enough test scenarios.
Tests Automated - Number of test scenarios running autonomously.
Success rate - Percentage of passing tests.
Cost savings - Financial benefits gained through automated vs manual testing (approx).
Three charts display:
Test distribution across systems
Test execution times
Types of tests in use
Check metrics anytime to track performance and make testing decisions.
Monitoring
You can track you API health in real-time. Set up monitoring sections by department or micro-service, create specific alert conditions, and define notification rules for when issues occur. The system will automatically notify relevant team members based on your configured escalation rules.
Build Reports
You can access detailed information about all test executions. View results of individual tests, performance data for test suites, and outcomes of scheduled test plans. The reporting system clearly identifies where issues occur in your testing workflow, helping you with troubleshooting.
Generate Documentation
API documentation in QodexAI stays current automatically. From the Collections section, use the "Generate Documentation" button to create comprehensive documentation of your APIs. The generated documents show all your APIs, their purposes, and how they interconnect. When you update your API collection, the documentation updates automatically to reflect any changes.
API documentation in QodexAI stays current automatically. From the Collections section, use the "Generate Documentation" button to create comprehensive documentation of your APIs. The generated documents show all your APIs, their purposes, and how they interconnect. When you update your API collection, the documentation updates automatically to reflect any changes.
API documentation in QodexAI stays current automatically. From the Collections section, use the "Generate Documentation" button to create comprehensive documentation of your APIs. The generated documents show all your APIs, their purposes, and how they interconnect. When you update your API collection, the documentation updates automatically to reflect any changes.
Need Help?
You can email us at care@qodex.ai or book a chat with our team link
Ready to make API testing less painful? Fire up Qodex.ai and let's go. 🚀
You can email us at care@qodex.ai or book a chat with our team link
Ready to make API testing less painful? Fire up Qodex.ai and let's go. 🚀
You can email us at care@qodex.ai or book a chat with our team link
Ready to make API testing less painful? Fire up Qodex.ai and let's go. 🚀
FAQs
Why should you choose Qodex.ai?
Why should you choose Qodex.ai?
Why should you choose Qodex.ai?
Remommended posts
Hire our AI Software Test Engineer
Experience the future of automation software testing.
Copyright © 2024 Qodex
|
All Rights Reserved
Hire our AI Software Test Engineer
Experience the future of automation software testing.
Copyright © 2024 Qodex
All Rights Reserved
Hire our AI Software Test Engineer
Experience the future of automation software testing.
Copyright © 2024 Qodex
|
All Rights Reserved