A Guide to Amplify CLI - Part 2 - REST API

Introduction

In post, I'll walk you through the process of adding an API to your Amplify project. If you haven't initialized any Amplify project yet, head on to A Guide to Amplify CLI - Part 1

Before we start I assume you have already initialized an Amplify project on your system and have NPM installed.

In this post, I'll cover:

- amplify <category> add
- amplify <category> update
- amplify <category> remove
- amplify <category> push

Steps:

1. After your Amplify project has been initialized with `amplify init`, next type `amplify add api` on CMD.
2. Under mentioned services, select `REST`.

3. Next, type any name for your resource to be used as label. I am going with `products`

4. Next, give a path for your REST endpoint. For keeping it simple, let's go with `/product-items`

5. For `Lambda source`, it chooses `Create a new Lambda function` by itself. Next. type an AWS Lambda name for this. Example: ProductsLambda.

6. Choose `NodeJS` as the runtime.

7. Under `Choose the function template..`, select `Serverless ExpressJS function..`. The Lambda function template `Serverless ExpressJS function` implements route handlers for GET, POST, PUT and DELETE HTTP methods and paths for `/product-items` and `/product-items/*   `.

8. Type `N` to not configure advanced settings. We will touch this part later. Type 'Y' for "...edit the local lambda function now..". After this step, `src/app.js` opens in your VS Code window. 

9. Come back to your CMD and press enter to continue. Type 'Y' for "Restrict API access", next select `Authenticated and Guest user` for "Who should have access..", next under "What permissions..  grant to Authenticated users..", press spacebar on the entries if you want to select multple. Here, you should select all of them: create, read, update and delete. Use arrow keys to move up or down. After you have selected, press Enter.

10. Under "..permissions.. to Guest users", select only `read`.

11. Type `n` for "..add another path" and press Enter.

12. You get "Successfully added resource products locally" message on your CMD when configurations of your API is complete.

13. Let's deploy our new API to the cloud by typing the command: amplify push.

Now, what's next??

Comments

Post a Comment

Popular

How To Create MySQL Table with SequelizeJS

Image
Hello, in this post I will be showing how you can create an SQL table using JavaScript without the knowledge of MySQL. Sequelize is a promise-based  Node.js   ORM tool  for  Postgres ,  MySQL ,  MariaDB ,  SQLite ,  Microsoft SQL Server ,  Amazon Redshift  and  Snowflake’s Data Cloud . It features solid transaction support, relations, eager and lazy loading, read replication and more.
OPEN

How To Read CSV Files in Java as Maven Project

Image
Many of us have problems reading CSV files in Java but not anymore!. In this guide, I will share how to read CSV files as Maven Project. For creating a Maven project: In your Eclipse IDE, click on File > New > Project... > Maven >Maven Project > Next > Check "Create a simple project" checkbox. Under Group Id: The name could be anything. It is same as any package name. E.g. in.sumitkp Under Artifact Id: Same as above It is same as any project name. E.g. maven-demo1 Let the Version be the default. Under Name: Give the name for your project Click Finish. In your Project Explorer, all the necessary files will be automatically generated. Inside the root folder, there will be an XML file auto-generated called  pom.xml . About pom.xml: POM stands for Project Object Model It is an XML file that contains information about the project and configuration details used by Maven to build the project. When running a task, Maven looks for the pom.xml file in the directory. I...
OPEN

How To Create A Hibernate Project in Maven

Image
In this post, I will be showing you how to create a Hibernate project using Maven and how we can add MySQL dependencies to it. Here, is a whole process picture which you can click and follow the steps. The direction of the process has been indicated by arrow icons. Now, configuring the Hibernate XML file: Inside your project folder, right-click on 'src/main/java' and select New > Other... > Type filter text: xml > Under XML folder, click on XML File > Click Next > Under File Name, type: hibernate.cfg.xml > Finish. Inside this hibernate.cfg.xml file, we would now need a dtd line. dtd stands for 'document type definition'. It defines the tagging structure of an XML document. For this, search on Google or any search engine: hibernate dtd. Find for the result that says "Index of /dtd - Hibernate". Click the link or go to  https://hibernate.org/dtd/  . On the next page, click on either of these three links. A dtd file will be downloaded. Open the ...
OPEN