API Design for Beginners

Source code for the API design for beginners book.

Prerequisites

• git v2 or greater
• Node Js v8 or greater
• yarn v1 or greater (or npm v6 or greater)
• postgreSQL v11 or greater

All of these must be available in your PATH. To verify things are set up properly, you can run this:

git --version
node --version
yarn --version # or npm --version

If you have trouble with any of these, learn more about the PATH environment variable and how to fix it here for windows or mac/linux.

A good code editor like VS Code is preferred.

Installing postgres

Postgres is little tricky to install and get it running. You can download it here and follow the steps for respective OS.

For installing postgres in respective OS,

• For windows
• For macOS
• For linux distribution
• Using docker

For connecting to postgres, check the guide here.

Run the API server

For running the final project,

npm install # install the node modules
npm start # start the server locally on port 6060

Code for each chapter

You have the source code for all chapter. You can go to any chapter code in the folder code/<chapter-name>.

Then run the server. It will show the output specific to that chapter.