{"id":20753055,"url":"https://github.com/jmfiola/jest-api-test-typescript-example","last_synced_at":"2025-08-20T08:11:04.088Z","repository":{"id":182397042,"uuid":"462062484","full_name":"jmfiola/jest-api-test-typescript-example","owner":"jmfiola","description":"An example repository which provides the necessary boilerplate for a reusable and maintainable jest test framework","archived":false,"fork":false,"pushed_at":"2022-02-23T01:49:22.000Z","size":442,"stargazers_count":7,"open_issues_count":0,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-28T14:26:21.920Z","etag":null,"topics":["api-testing","api-testing-framework","jest","rest-api","restful-api","test-automation","test-framework","testing-tools","typescript","typescript-tests"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jmfiola.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-02-21T23:15:17.000Z","updated_at":"2024-03-09T04:50:51.000Z","dependencies_parsed_at":"2023-07-19T20:55:13.019Z","dependency_job_id":null,"html_url":"https://github.com/jmfiola/jest-api-test-typescript-example","commit_stats":null,"previous_names":["jmfiola/jest-api-test-typescript-example"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jmfiola/jest-api-test-typescript-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmfiola%2Fjest-api-test-typescript-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmfiola%2Fjest-api-test-typescript-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmfiola%2Fjest-api-test-typescript-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmfiola%2Fjest-api-test-typescript-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmfiola","download_url":"https://codeload.github.com/jmfiola/jest-api-test-typescript-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmfiola%2Fjest-api-test-typescript-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271285506,"owners_count":24732923,"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","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-testing","api-testing-framework","jest","rest-api","restful-api","test-automation","test-framework","testing-tools","typescript","typescript-tests"],"created_at":"2024-11-17T08:43:29.507Z","updated_at":"2025-08-20T08:11:04.052Z","avatar_url":"https://github.com/jmfiola.png","language":"TypeScript","readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Build Status][build-shield]][build-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/jmfiola/jest-api-test-typescript-example\"\u003e\n    \u003cimg src=\"https://res.cloudinary.com/practicaldev/image/fetch/s--J6qf2Ctw--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://thepracticaldev.s3.amazonaws.com/i/gd97g4kdyk1bpdeyfqst.png\" alt=\"Logo\" width=\"200\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eJest Api Test Framework: A TypeScript Example\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    This is an example repository which provides the necessary boilerplate code for a reusable and maintainable jest api test framework using TypeScript.\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/jmfiola/jest-api-test-typescript-example/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/jmfiola/jest-api-test-typescript-example/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nThis is a basic test framework that hits the [Chuck Norris Jokes API](https://api.chucknorris.io/) following 3 core values:\n1. Endpoint functionality should be wrapped by a class method which is abstracted as much as possible 🌌\n\n2. Those class methods should be unit tested 🧪\n\n3. Actual API tests will then import those class methods to interact with the live API 🔎\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n### Built With\n\n* [TypeScript](https://www.typescriptlang.org/)\n* [Node.js](https://nodejs.org/en/about/)\n* [Jest](https://jestjs.io/docs/getting-started)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n### Prerequisites\n\nYou will want the latest version of npm installed. For reference, this project was developed with npm version `8.5.1`. \n  ```sh\n  npm install npm@latest -g\n  ```\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/jmfiola/jest-api-test-typescript-example.git\n   ```\n3. Install NPM packages\n   ```npm\n   npm install\n   ```\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\n1. Run the unit tests for the framework with code coverage\n   ```npm\n   npm run unit:test\n   ```\n2. Run the functional tests which actually hit the live Chuck Norris API\n   ```npm\n   npm run functional:test\n   ```\n\nYou can use this framework as a starting point for whatever API tests you would like to run. This framework allows for the flexibility of running tests which have free range with what headers they use, what routes they call, etc. whilst also providing easy-to-use, reusable, unit tested class methods. This makes the tests a lot more accessible to test writers and framework maintainers!\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\n- [ ] Dockerization\n- [ ] Reporting Integration\n- [ ] Tag-based test collection\n\nSee the [open issues](https://github.com/jmfiola/jest-api-test-typescript-example/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. My venmo is [@Jacob-Fiola](https://account.venmo.com/u/Jacob-Fiola)! 😉\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nProject Link: [https://github.com/jmfiola/jest-api-test-typescript-example](https://github.com/jmfiola/jest-api-test-typescript-example)\n\nEmail: jmfiola21@gmail.com\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/jmfiola/jest-api-test-typescript-example.svg?style=for-the-badge\n[contributors-url]: https://github.com/jmfiola/jest-api-test-typescript-example/graphs/contributors\n[build-shield]: https://img.shields.io/github/workflow/status/jmfiola/jest-api-test-typescript-example/CI.svg?style=for-the-badge\n[build-url]: https://github.com/jmfiola/jest-api-test-typescript-example/actions\n[forks-shield]: https://img.shields.io/github/forks/jmfiola/jest-api-test-typescript-example.svg?style=for-the-badge\n[forks-url]: https://github.com/jmfiola/jest-api-test-typescript-example/network/members\n[stars-shield]: https://img.shields.io/github/stars/jmfiola/jest-api-test-typescript-example.svg?style=for-the-badge\n[stars-url]: https://github.com/jmfiola/jest-api-test-typescript-example/stargazers\n[issues-shield]: https://img.shields.io/github/issues/jmfiola/jest-api-test-typescript-example.svg?style=for-the-badge\n[issues-url]: https://github.com/jmfiola/jest-api-test-typescript-example/issues\n[license-shield]: https://img.shields.io/github/license/jmfiola/jest-api-test-typescript-example.svg?style=for-the-badge\n[license-url]: https://github.com/jmfiola/jest-api-test-typescript-example/blob/master/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/jacob-fiola\n[product-screenshot]: images/screenshot.png\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmfiola%2Fjest-api-test-typescript-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmfiola%2Fjest-api-test-typescript-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmfiola%2Fjest-api-test-typescript-example/lists"}