{"id":20128085,"url":"https://github.com/osandadeshan/maxsoft-intelliapi","last_synced_at":"2025-05-06T18:32:08.789Z","repository":{"id":25035729,"uuid":"103026017","full_name":"osandadeshan/maxsoft-intelliapi","owner":"osandadeshan","description":"First-ever code-free and lightweight cross platform API and database test automation tool.","archived":false,"fork":false,"pushed_at":"2024-01-22T17:19:01.000Z","size":95885,"stargazers_count":13,"open_issues_count":2,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-23T11:19:26.074Z","etag":null,"topics":["gauge","intelliapi","java","maven","maxsoft","rest-api","rest-assured"],"latest_commit_sha":null,"homepage":"https://medium.com/intelliapi","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osandadeshan.png","metadata":{"files":{"readme":"ReadMe.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-09-10T12:02:37.000Z","updated_at":"2024-02-18T03:54:18.000Z","dependencies_parsed_at":"2022-08-19T17:40:50.287Z","dependency_job_id":"f4a29361-4ad7-4ac5-8d53-5803b5118fe5","html_url":"https://github.com/osandadeshan/maxsoft-intelliapi","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmaxsoft-intelliapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmaxsoft-intelliapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmaxsoft-intelliapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmaxsoft-intelliapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osandadeshan","download_url":"https://codeload.github.com/osandadeshan/maxsoft-intelliapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224519272,"owners_count":17324772,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gauge","intelliapi","java","maven","maxsoft","rest-api","rest-assured"],"created_at":"2024-11-13T20:25:22.217Z","updated_at":"2024-11-13T20:25:22.862Z","avatar_url":"https://github.com/osandadeshan.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MaxSoft IntelliAPI\n\n## Introduction\nThe main reason for developing this framework is to provide an easy way for Technical QA, Developer or Non-technical QA to perform API testing in an easy manner.\n\n## Advantages\n- Ability to implement automated tests for an API within few minutes.\n- Codeless API automation.\n- Ability to validate backend databases.\n- Tests can be designed even by a non- technical person.\n- Human readable tests in business language and markdown syntax.\n- Generation of an executable document.\n- Generate a HTML report with test details for every test execution.\n- Parallel execution.\n- Live execution report.\n- Automated emails for test execution summary with graphical representations.\n\n## Technologies/Frameworks Used\n- Java\n- Gauge Framework\n- Rest Assured\n- Apache POI\n- Junit\n- Apache Maven\n\n## Supported Platforms\n- Windows\n- Linux\n- Mac OS\n\n## Supported Languages\n- Java\n\n## Design Diagram\n![image](https://user-images.githubusercontent.com/9147189/104115454-a1ed7d00-5335-11eb-9e23-0f75137068af.png)\n\n## Pre Requisites\n1. Java\n2. Maven\n\n## Installing Gauge Core\n**On Windows**\n1. Install Chocolatey by executing the following command in an administrator command prompt. \\\n`@\"%SystemRoot%\\System32\\WindowsPowerShell\\v1.0\\powershell.exe\" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command \"[System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))\" \u0026\u0026 SET \"PATH=%PATH%;%ALLUSERSPROFILE%\\chocolatey\\bin\"`\n\n2. Install Gauge by executing the following command in an administrator command prompt. \\\n`choco install gauge`\n\n**On MacOS**\n1. Update Homebrew. \\\n`brew update`\n\n2. Install Gauge using Homebrew. \\\n`brew install gauge`\n\n**On Linux**\n1. First, add Gauge’s GPG key with this command. \\\n`sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net --recv-keys 023EDB0B`\n\n2. Then add Gauge to the repository list using this command. \\\n`echo deb https://dl.bintray.com/gauge/gauge-deb nightly main | sudo tee -a /etc/apt/sources.list`\n\n3. Finally, install Gauge using these commands. \\\n`sudo apt-get update` \\\n`sudo apt-get install gauge`\n\n## Installing Gauge Plugins\n1. Open Command Prompt and execute following commands. \\\n`gauge install java` \\\n`gauge install html-report` \\\n`gauge install json-report` \\\n`gauge install xml-report` \\\n`gauge install spectacle` \\\n`gauge install flash`\n\n2. You can check the installation using the following command. \\\n`gauge -v`\n\n\tIf the installation is success, it will output like this:\n\n```markdown\n    Gauge version: \u003cversion number\u003e\n    Plugins\n    -------\n    flash (\u003cversion number\u003e)\n    html-report (\u003cversion number\u003e)\n    java (\u003cversion number\u003e)\n    json-report (\u003cversion number\u003e)\n    spectacle (\u003cversion number\u003e)\n    xml-report (\u003cversion number\u003e)\n```\n\n## Tested Versions\n| OS \t\t\t    | Java Version   | Maven Version | Gauge Version | Gauge Java Version |\n| ------------------------- | -------------- | ------------- | ------------ | ------------------- |\n| Windows 10 Enterprise     | 1.8.0_181      | 3.6.1 \t     | 1.1.6 \t    | 0.7.13\t\t  |\n| Windows 10 Enterprise     | 1.8.0_181      | 3.6.1 \t     | 1.2.1 \t    | 0.7.15\t\t  |\n| Windows 10 Enterprise     | 1.8.0_131      | 3.5.0 \t     | 1.1.7 \t    | 0.7.13\t\t  |\n| Windows 10 \t\t    | 1.8.0_271      | 3.6.3 \t     | 1.1.6\t    | 0.7.13 \t\t  |\n| Ubuntu 18.04 \t\t    | 1.8  \t     | 3.6.3 \t     | 1.1.7 \t    | 0.7.13 \t\t  |\n| MacOS Catalina v10.15.7   | 1.8.0_275      | 3.6.3 \t     | 1.1.7 \t    | 0.7.13 \t\t  |\n\n## MaxSoft IntelliAPI Tutorials\n1. [MaxSoft IntelliAPI](https://medium.com/@osanda.deshan/maxsoft-ata-framework-for-api-test-automation-9cffd25a0b15 \"MaxSoft — IntelliAPI\")\n2. [MaxSoft IntelliAPI Documentation](https://medium.com/intelliapi/maxsoft-intelliapi-step-implementations-usages-5cb9150e0106)\n3. [How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 1](https://medium.com/@osanda.deshan/how-to-use-maxsoft-ata-framework-for-api-test-automation-e5966185fa33 \"How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 1\")\n4. [How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 2](https://medium.com/@osanda.deshan/how-to-use-maxsoft-ata-framework-for-api-test-automation-tutorial-2-53b50c613f42 \"How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 2\")\n5. [How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 3](https://medium.com/@osanda.deshan/how-to-use-maxsoft-ata-framework-for-api-test-automation-tutorial-3-160f81e404f1 \"How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 3\")\n6. [How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 4](https://medium.com/@osanda.deshan/how-to-use-maxsoft-ata-framework-for-api-test-automation-tutorial-4-5fb265ca5eaf \"How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 4\")\n7. [How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 5](https://medium.com/@osanda.deshan/how-to-use-maxsoft-ata-framework-for-api-test-automation-tutorial-5-3b2c22328233 \"How to use MaxSoft IntelliAPI for API Test Automation? — Tutorial 5\")\n\n## Testing the Project\n1) Go to **execution_scripts/batch_scripts** folder in the project root directory.\n2) Double click on **dev_regression_run.bat** file. \\\nOR \\\nRun below commands on the terminal \\\n`mvn test-compile gauge:execute -DspecsDir=\"specs\" -Dtags=\"pre_requisites\" -Denv=\"dev\"` \\\n`mvn test-compile gauge:execute -DspecsDir=\"specs\" -Denv=\"dev\"`\n\n## Support Forum\n[Gitter](https://gitter.im/MaxSoft-IntelliAPI/community)\n\n## License\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/License_icon-mit-2.svg/2000px-License_icon-mit-2.svg.png\" alt=\"MIT License\" width=\"100\" height=\"100\"/\u003e [MaxSoft IntelliAPI](https://medium.com/intelliapi) is released under [MIT License](https://opensource.org/licenses/MIT)\n\n## Copyright\nCopyright 2021 [MaxSoft](https://maxsoftlk.github.io/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosandadeshan%2Fmaxsoft-intelliapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosandadeshan%2Fmaxsoft-intelliapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosandadeshan%2Fmaxsoft-intelliapi/lists"}