pod-point-work-with / tech-test-api-specs

Stoplight Studio RESTful API specification for technical tests

Pod Point Technical Test RESTful API Specifications

This is a Stoplight Studio RESTful API specification we use throughout some of our technical tests.

Installation

You can install this on any of our technical test re-using the same RESTful API implementation.

git clone [email protected]:Pod-Point/tech-test-api-specs.git reference

If you're an applicant and landed here, you shouldn't need to worry about pulling this manually, it should automatically be available for you within /reference after running make start.

How to use it

You can use Stoplight Studio in order to browse the API documentation within the /reference folder you just created by cloning this repository:

You can also import the Open API v3 file located under /reference/pod-point/openapi.yml into Postman in order to automatically create a Collection. Once imported, make sure your Collection variables (mainly baseUrl) are accurate.

---

Travel shouldn't damage the earth 🌍

Made with ❤️  at Pod Point