Aravindk12345 / apiTesting-mocha-boilerplate

Boilerplate project to run RESTful API tests with mocha.

Home Page:https://github.com/Aravindk12345/apiTesting-mocha-boilerplate

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

apiTesting-mocha-boilerplate

- Boilerplate project to run RESTful API tests with mocha.

dependencies Status Dev dependencies Status License: Apache 2.0 Contributers:

  • Boiler Plate for getting started with Api Testing with
    • Mocha as test runner.
    • should.js as assertion library.
    • supertest to make HTTP requests.
    • json-server to create a RESTful-Api.
    • Faker.js to create a user data.
    • ajv to make schema validations.
    • mochawesome as Reporter.

System Requirements

  • JAVA JDK
  • npm
  • IDE

Dependencies (major)

  • Mocha framework
  • supertest
  • npm
  • node

How to setup (local)

  • Clone the github project
  • Navigate to project directory
  • npm Install

How to Run (local)

  • Set the ENVIRONMENT variable i.e in cmd export ENVIRONMENT="http://localhost:"
  • Set the ENVEXT variable i.e in cmd export ENVEXT="3000/"
  • In new cmd you need to run: npm run apiserver
  • Now Run your scripts: npm run test.api

Code Review checklist

  • You can find the code review checklist in the doc folder Checklist that is good enough to follow.
  • You are always welcome to add are modify the code checklist.

Contributing

  • Fork it
  • Create your feature branch (git checkout -b feature/fooBar)
  • Commit your changes (git commit -am 'Add some fooBar')
  • Push to the branch (git push origin feature/fooBar)
  • Create a new Pull Request

Authors

  • Aravind Reddy K
  • If you like it Star ⭐ It.

License

This project is licensed under the Apache License 2.0 - see the License file for details

About

Boilerplate project to run RESTful API tests with mocha.

https://github.com/Aravindk12345/apiTesting-mocha-boilerplate

License:Apache License 2.0


Languages

Language:JavaScript 100.0%