Deploy Your Own REST API in 30 Mins Using mLab and Heroku

Deploy Your Own REST API in 30 Minutes: A Guide Using mLab and Heroku

Key Highlights:

This tutorial demonstrates building and deploying a RESTful API using the MEAN stack (MongoDB, Express.js, AngularJS, Node.js) on Heroku, with MongoDB hosted on mLab. Learn how to:

• Deploy a REST API rapidly using Heroku's streamlined git push heroku master deployment process.
• Manage application data efficiently with a MongoDB database provisioned via mLab.
• Implement core CRUD (Create, Read, Update, Delete) operations within your API.
• Develop a user-friendly front-end using AngularJS to interact seamlessly with your API.
• Leverage AngularJS controllers and services for improved data management and user experience.

(Originally published on the Heroku Dev Center)

The MEAN stack's popularity stems from its JavaScript-centric approach, allowing consistent coding across client and server sides. This synergy with JSON (JavaScript Object Notation) – MongoDB's data format – simplifies development. While MEAN excels in browser-based applications, it's equally effective for creating RESTful APIs, crucial for supporting diverse client devices. This tutorial focuses on API creation; AngularJS is included to illustrate front-end integration.

Our example is a simple contact management application. We'll first build the REST API to interact with the MongoDB database, then create an AngularJS web application as a user interface. Finally, we'll deploy the complete application to Heroku. For simplicity, features like authentication and robust data validation are omitted.

Prerequisites:

• A Heroku account (familiarize yourself with Heroku's Node.js deployment if needed).
• Heroku Toolbelt installed.
• Node.js installed.

Project Structure:

The source code (https://www.php.cn/link/ed80be7e22f987619ac49099673ad49f) includes:

• package.json: Metadata and dependencies for your Heroku application.
• app.json: Heroku app manifest (required for the "Deploy to Heroku" button).
• server.js: Server-side code (Node.js, Express.js, MongoDB driver).
• /public directory: Client-side files (AngularJS code).

Live Demo:

View a working example here: https://www.php.cn/link/4e79ea6638ba8bc06d414c9fc94760f7

Step-by-Step Guide:

1. Create a New Heroku App:

   $ git init
   $ heroku create

2. Create package.json: Create this file and add the following:

   {
     "name": "MEAN",
     "version": "1.0.0",
     "description": "A MEAN app for managing contact lists",
     "main": "server.js",
     "scripts": {
       "start": "node server.js"
     },
     "dependencies": {
       "body-parser": "^1.13.3",
       "express": "^4.13.3",
       "mongodb": "^2.1.6"
     }
   }

3. Install Dependencies:

   $ npm install

4. Provision a MongoDB Database on mLab:

   • Sign up for a free mLab account.

   • Create a new MongoDB database.

   • Obtain the MongoDB connection string.

   • Set the MONGODB_URI config variable on Heroku:

     heroku config:set MONGODB_URI=mongodb://your-user:your-pass@host:port/db-name

5. Connect MongoDB and the App Server (server.js): Create server.js with the database connection code (detailed in the original article).

6. Create the RESTful API (server.js): Implement the API endpoints (/contacts, /contacts/:id) for CRUD operations (detailed in the original article).

7. Deploy to Heroku:

   $ git add .
   $ git commit -m "Initial commit"
   $ git push heroku master
   $ heroku ps:scale web=1

8. Set up Static Files for the Web App: Create the /public directory and add the AngularJS code (detailed in the original article).

9. Deploy the Web App:

   $ git add public
   $ git commit -m "Add AngularJS frontend"
   $ git push heroku master
   $ heroku open

The remaining steps, including detailed AngularJS implementation and further deployment instructions, are available in the original article. This condensed version provides a high-level overview and key code snippets. Remember to replace placeholder values with your actual Heroku app name, mLab credentials, etc.

The above is the detailed content of Deploy Your Own REST API in 30 Mins Using mLab and Heroku. For more information, please follow other related articles on the PHP Chinese website!