william-olson/cars-api

Simple REST API demo for storing Cars

Cars API

Simple Node.js server that serves a REST API for managing cars. Implemented with Express and TypeScript.

Connects and stores data to a MySQL database and utilizes Elasticsearch for fast searching capabilities.

API Docs

See: API Reference Documentation.

Running Locally

Requirements

• Docker
• NodeJS (version 8.x.x or later)
• NPM (version 5.x.x or later)
• Make (for running the Makefile)

Simply run the make command from your terminal while in the repository's root directory.

make

This will start the database as a Docker container then build and run the API Server locally. The server should be available at http://localhost:3000 once started.

Swagger

You can use the Swagger UI when running the API locally.

It should automatically be served at http://localhost:3000/api-docs/swagger.

Swagger makes it easy to build requests and parameters for testing the API.

Postman

If you are familiar with Postman, there are postman collections for this API here. Import one of them into Postman to start using the collection.