diff --git a/README (1).md b/README (1).md new file mode 100644 index 0000000..c125361 --- /dev/null +++ b/README (1).md @@ -0,0 +1,9 @@ +# What is an API + +Application Programming Interfaces (APIs) have completely overtaken how we use mobile and web applications by allowing software to interact with other software. Today, we use APIs as a key entry point for any data, service, and integration access. + +An API is an interface that allows two pieces of software to communicate with each other. It provides a way for one program to request data from another program, and for the other program to respond to that request. + +An API can be thought of as a set of rules that govern how two pieces of software interact with each other. When one piece of software wants to request data from another piece of software, it does so by following the API's rules. The API then tells the second piece of software how to respond to the request. + +![](<.gitbook/assets/image (54).png>) diff --git a/README.md b/README.md index c125361..a0134ac 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ -# What is an API +# Loadmill - AI - Powered Solution -Application Programming Interfaces (APIs) have completely overtaken how we use mobile and web applications by allowing software to interact with other software. Today, we use APIs as a key entry point for any data, service, and integration access. +Loadmill automates testing by replaying and analyzing real user behavior, helping developers easily create the tests required for continuous delivery. Loadmill creates and replays thousands of tests based on user flows within minutes. -An API is an interface that allows two pieces of software to communicate with each other. It provides a way for one program to request data from another program, and for the other program to respond to that request. +Loadmill's AI-powered test case generator can help you create comprehensive, reliable test cases for your APIs in minutes. By composing API requests and correlating them with Loadmill's algorithms, you can generate dynamic, automated test cases that are ready to use. With Loadmill, you can quickly and easily create comprehensive test suites for your APIs that will ensure their reliability and performance. -An API can be thought of as a set of rules that govern how two pieces of software interact with each other. When one piece of software wants to request data from another piece of software, it does so by following the API's rules. The API then tells the second piece of software how to respond to the request. +Imagine a scenario where you need to add a user to your company’s database by submitting a form and then verifying that a user exists by validating its id provided when it's added to the database. + +This is a common process where the form will make a `POST` request to the server. The `POST` request connects to the server location through the server's URL path and passes in the user information inside the body of the request. + +If the user has been successfully added, the server sends back the `status 200` of the request notifying the request has been successful and the id of the user that has been added to the database. + +![](<.gitbook/assets/image (2) (2).png>) + +You'll then make a `GET` request to the server by passing in that response `id` from the previous `POST` request (either inside of the body or in your URL). If everything went right and you're successful, you'll get a response back from your server saying whether or not the user's `id` expired. + +![](<.gitbook/assets/image (1) (1) (4).png>) -![](<.gitbook/assets/image (54).png>) diff --git a/SUMMARY.md b/SUMMARY.md index d66d5e8..0d6e25a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -2,13 +2,13 @@ ## Introduction -* [What is an API](README.md) - * [What is an API endpoint?](introduction/what-is-an-api/what-is-an-api-endpoint.md) +* [Loadmill - AI - Powered Solution](README.md) +* [What is an API]() * [API - Data Fetching](introduction/what-is-an-api/api-data-fetching.md) * [Quick examples of API requests](introduction/what-is-an-api/quick-examples-of-api-requests.md) + * [What is an API endpoint?](introduction/what-is-an-api/what-is-an-api-endpoint.md) * [API Server Testing](introduction/api-server-testing/README.md) * [Regression Testing](introduction/api-server-testing/regression-testing.md) - * [Loadmill - AI-Powered Solution](introduction/api-server-testing/loadmill-ai-powered-solution.md) ## Quick Guide diff --git a/introduction/api-server-testing/loadmill-ai-powered-solution.md b/introduction/api-server-testing/loadmill-ai-powered-solution.md deleted file mode 100644 index ae771f7..0000000 --- a/introduction/api-server-testing/loadmill-ai-powered-solution.md +++ /dev/null @@ -1,18 +0,0 @@ -# Loadmill - AI-Powered Solution - -Loadmill automates backend regression testing by replaying and analyzing real user behavior, helping developers easily create the tests required for continuous delivery. Loadmill creates and replays thousands of tests based on user flows within minutes. - -Loadmill's AI-powered test case generator can help you create comprehensive, reliable test cases for your APIs in minutes. By composing API requests and correlating them with Loadmill's algorithms, you can generate dynamic, automated test cases that are ready to use. With Loadmill, you can quickly and easily create comprehensive test suites for your APIs that will ensure their reliability and performance. - -Imagine a scenario where you need to add a user to your company’s database by submitting a form and then verifying that a user exists by validating its id provided when it's added to the database. - -This is a common process where the form will make a `POST` request to the server. The `POST` request connects to the server location through the server's URL path and passes in the user information inside the body of the request. - -If the user has been successfully added, the server sends back the `status 200` of the request notifying the request has been successful and the id of the user that has been added to the database. - -![](<../../.gitbook/assets/image (2) (2).png>) - -You'll then make a `GET` request to the server by passing in that response `id` from the previous `POST` request (either inside of the body or in your URL). If everything went right and you're successful, you'll get a response back from your server saying whether or not the user's `id` expired. - -![](<../../.gitbook/assets/image (1) (1) (4).png>) -