{"id":14717622,"url":"https://github.com/mfaisalkhatri/restful-ecommerce","last_synced_at":"2025-03-21T01:32:18.126Z","repository":{"id":255511782,"uuid":"851187683","full_name":"mfaisalkhatri/restful-ecommerce","owner":"mfaisalkhatri","description":"A free to use E-Commerce Web APIs for practising API testing.","archived":false,"fork":false,"pushed_at":"2025-01-31T13:33:12.000Z","size":7006,"stargazers_count":31,"open_issues_count":1,"forks_count":9,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-15T17:54:17.967Z","etag":null,"topics":["api","api-testing","e-commerce","expressjs","hacktoberfest","nodejs","rest-api","testing","training","web-apis"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mfaisalkhatri.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-02T15:34:07.000Z","updated_at":"2025-03-05T16:57:28.000Z","dependencies_parsed_at":"2024-10-28T09:14:23.258Z","dependency_job_id":"f5e293cf-c701-41f7-b00b-5f3e448d41fb","html_url":"https://github.com/mfaisalkhatri/restful-ecommerce","commit_stats":null,"previous_names":["mfaisalkhatri/restful-ecommerce"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfaisalkhatri%2Frestful-ecommerce","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfaisalkhatri%2Frestful-ecommerce/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfaisalkhatri%2Frestful-ecommerce/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfaisalkhatri%2Frestful-ecommerce/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mfaisalkhatri","download_url":"https://codeload.github.com/mfaisalkhatri/restful-ecommerce/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244099416,"owners_count":20397952,"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":["api","api-testing","e-commerce","expressjs","hacktoberfest","nodejs","rest-api","testing","training","web-apis"],"created_at":"2024-09-13T23:00:59.939Z","updated_at":"2025-03-21T01:32:17.554Z","avatar_url":"https://github.com/mfaisalkhatri.png","language":"JavaScript","funding_links":[],"categories":["Don't forget to give a :star: to make the project popular","API Testing"],"sub_categories":[],"readme":"![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)\n\n# Restful E-Commerce\n\nA simple Node E-Commerce application for testing RESTful web services. \nThis application is built for testers to practice API Testing Manually using tools like [Postman](https://www.postman.com/downloads/) or using API Test Automation tools like [SuperTest](https://www.npmjs.com/package/supertest), [Rest-Assured](https://rest-assured.io/), [Playwright](https://playwright.dev/java/docs/api-testing), [Cypress](https://learn.cypress.io/advanced-cypress-concepts/integration-and-api-tests), [Boyka-Framework](https://github.com/BoykaFramework/boyka-framework), etc.\n\n## Don't forget to give a :star: to make the project popular\n\n# Installation Steps\n1. Clone the repo\n1. Navigate into the restful-ecommerce root folder\n1. Run `npm install`\n1. Run `npm start`\n\nAPIs are exposed on http://localhost:3004/\n\nSwagger is exposed on http://localhost:3004/api-docs\n\n## Importing the API Collection into Postman\n\n1. Visit `http://localhost:3004/swagger.json` to generate and download the Swagger JSON file\n1. The Swagger JSON file will be saved as `swagger-output.json` in your project directory\n1. Open `Postman` app and click on `Import`\n1. Select file `swagger-output.json` from the root folder of the project\n1. Select `OpenAPI 3.0 with a Postman Collection` and click on `Import`\n1. All the Available APIs will be imported in Postman and can be used for testing\n\n# Installation using Docker\n1. Clone the repo\n1. Navigate into the restful-ecommerce root folder\n1. Run `docker compose -f docker-compose-ecommerce.yml up -d` - This command will start the application in detached mode\n1. APIs are exposed on http://localhost:3004/\n1. Swagger is exposed on http://localhost:3004/api-docs\n\n1. Run `docker compose -f docker-compose-ecommerce.yml down` to stop the application.\n\n# Running the Unit Tests\n\nAfter running all the steps mentioned in the `Installation steps` section, the following command will execute all the unit-tests. (It is optional to run the unit tests, these tests are written using Super-Test) \n1. Run `npm run unit-test`\n\n## Checkout the API Documentation on the [Wiki-Page](https://github.com/mfaisalkhatri/restful-ecommerce/wiki)\n\n## Tutorials of this Project \n\n### Blog\n\n- [RESTful E-Commerce API in Node.js: Demo APIs for API Testing](https://medium.com/@iamfaisalkhatri/restful-ecommerce-a-simple-demo-node-e-commerce-application-for-practising-api-testing-db867ed3be9f)\n\n### YouTube\n\n- RESTful E-Commerce API in Node.js: Demo APIs for API Testing | Open Source | Tutorial\n\n[![RESTful E-Commerce API in Node.js: Demo APIs for API Testing | Open Source | Tutorial](https://img.youtube.com/vi/9WDhjf-Qlo4/0.jpg)](https://www.youtube.com/watch?v=9WDhjf-Qlo4)\n\n\n## API Testing Tutorials\n\n- [Playwright Java API Testing | How to test POST requests?](https://medium.com/@iamfaisalkhatri/playwright-java-api-testing-how-to-test-post-requests-4c9102d3ab03)\n- [Playwright Java API Testing | How to test GET requests?](https://medium.com/@iamfaisalkhatri/playwright-java-api-testing-how-to-test-get-requests-c036b984cc6d)\n- [Playwright Java API Testing | How to test PUT requests?](https://medium.com/@iamfaisalkhatri/playwright-java-api-testing-how-to-test-put-requests-d6b1d054d64b)\n- [Playwright Java API Testing | How to test PATCH requests?](https://medium.com/@iamfaisalkhatri/playwright-java-api-testing-how-to-test-patch-requests-f6b0867d91e7)\n- [Playwright Java API Testing | How to test DELETE requests?](https://medium.com/@iamfaisalkhatri/playwright-java-api-testing-how-to-test-delete-requests-2ff77feb0383)\n- [Postman Learning Center](https://learning.postman.com/)\n- [Automating your API tests with REST Assured](https://testautomationu.applitools.com/automating-your-api-tests-with-rest-assured/)\n- [How to perform End to End API Testing using Playwright with Java and TestNG](https://medium.com/@iamfaisalkhatri/how-to-perform-end-to-end-api-testing-using-playwright-with-java-and-testng-26b318927115)\n- [End to End API Testing using rest-assured](https://medium.com/@iamfaisalkhatri/end-to-end-api-testing-using-rest-assured-a58c4ea80255)\n- [Learn API Testing using Rest-Assured | Tutorial | Part 1](https://www.youtube.com/live/xLKpdQE0oKY?si=VCija9_74KVhkdQK)\n- [Learn API Testing using Rest-Assured | Part 2 | Code Cleanup and Refactoring | Tutorial](https://www.youtube.com/live/AFQSolEeu74?si=QmRS9HTpjpHOcsq3)\n- [Curated lists of all Free learning resources for Software Test Automation Engineer ](https://github.com/mfaisalkhatri/awesome-learning)\n\n## :question: Need Assistance?\n\n- Discuss your queries by writing to me @ `mohammadfaisalkhatri@gmail.com`\n  OR ping me on any of the social media sites using the below link:\n    - [Linktree](https://linktr.ee/faisalkhatri)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfaisalkhatri%2Frestful-ecommerce","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmfaisalkhatri%2Frestful-ecommerce","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfaisalkhatri%2Frestful-ecommerce/lists"}