-
-
Notifications
You must be signed in to change notification settings - Fork 283
New sections to docs #790
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
TvisharajiK
wants to merge
5
commits into
main
Choose a base branch
from
new-sections
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
New sections to docs #790
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
66 changes: 66 additions & 0 deletions
66
versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| id: api-testing-add-suite | ||
| title: Adding New Test Suites | ||
| description: Guide to adding to new Suites using "Add New" | ||
| sidebar_label: Adding New Suite | ||
| tags: | ||
| - api-testing | ||
| - test-organization | ||
| - test-suite | ||
| - test-management | ||
| --- | ||
| # Adding a Test Suite | ||
|
|
||
| In this guide, we will walk through the process of adding a test suite in Keploy. Users can either manually provide the details for the test suite or directly import a curl command to create one. | ||
|
|
||
| ## Steps to Add a Test Suite | ||
|
|
||
| 1. **Click on the Plus Button** | ||
| - Navigate to the test suite section in the Keploy interface. | ||
| - Click on the `+` button to add a new test suite. | ||
|
|
||
| 2. **Provide Test Suite Details** | ||
| - Fill in the following fields: | ||
| - **Name**: Enter a unique name for the test suite. | ||
| - **Details**: Provide a brief description of the test suite. | ||
| - **Request**: Specify the request details, such as the HTTP method, URL, headers, and body. | ||
| - **Associations**: Define any associations or dependencies related to the test suite. | ||
|
|
||
| 3. **Import a Curl Command (Optional)** | ||
| - If you have a curl command, you can directly import it to create the test suite. | ||
| - Paste the curl command in the provided input field. | ||
| - Keploy will automatically parse the curl command and populate the test suite details. | ||
|
|
||
| 4. **Save the Test Suite** | ||
| - Once all the details are filled in, click on the `Save` button to create the test suite. | ||
|
|
||
| ## Example | ||
|
|
||
| ### Manual Entry | ||
| ```json | ||
| { | ||
| "name": "User Authentication", | ||
| "details": "Tests the login functionality.", | ||
| "request": { | ||
| "method": "POST", | ||
| "url": "https://api.example.com/login", | ||
| "headers": { | ||
| "Content-Type": "application/json" | ||
| }, | ||
| "body": { | ||
| "username": "test_user", | ||
| "password": "secure_password" | ||
| } | ||
| }, | ||
| "associations": ["auth-service", "user-database"] | ||
| } | ||
| ``` | ||
|
|
||
| ### Importing a Curl Command | ||
| ```bash | ||
| curl -X POST https://api.example.com/login \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{"username": "test_user", "password": "secure_password"}' | ||
| ``` | ||
|
|
||
| By following these steps, you can easily create and manage test suites in Keploy. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.