Hyper Cloud hyper Data Workshops, 26 Oct 2021

Previous Meeting

⏯

youtube image

►

From YouTube: hyper hello world workshop with NodeJS by Tom Wilson

Description

Tom Wilson presents a virtual workshop for the hyper Data Service, this workshop is 1 of 3 workshops showcasing the features of the hyper Data Service API. You can follow along with Tom using your GitHub account.

Here is the workshop repository:

https://github.com/hyper63/workshops-expressjs/tree/master/hello-world

A

Hello world for hyper api service hyper is an api that gives you access to several primitive services, like data storage, search, cache and queue. In this workshop, we will go through the data service at a very high level kind of a hello world level. How do I get started and how does the api feel? My name is tom wilson and let's go ahead and get started here. I have a github open and I'm going to sign in as kind of a anonymous user.

A

And then I'm going to jump to.

A

Hyper 63, slash workshops dash and we're going to do express js our node.js workshop and we're going to do the hello world one. So the hello world will basically set up an account on hyper and then we'll use hyper to create a mario character document and to get a mario character document. So in this uh workshop we're building a mario wiki who has characters and games and we're gonna um create the api for that wiki and we're going to create a couple of endpoints on that api.

A

You should be knowledgeable about http and json javascript we're using uh node.js in express in this workshop, but hyper. You can use uh really anything you want, because it's kind of a rest api um and then, of course, you should be familiar with get and github.

A

So before we uh get started, I'm going to go ahead and launch a virtual machine in get pod that will clone this repository and give us a starting point for the workshop, so I'll. Just click open in gitpod and use my github account and spin up that virtual workshop and while that's running I'm going to go and set up an app in the hyper dashboard. So I'm going to open a new tab and type dashboard.hyper.io.

A

And um it's going to prompt me to log in with github, so I'm going to do that and it'll walk you through the login and I'm going to go ahead and delete this app because it'll be worthwhile to start fresh with a new application.

A

So we'll come in to the hyper dashboard and you'll. Have your app add application button, just click it select your uh favorite name, uh honeydew cloud, maybe.

A

Doesn't matter just needs to be unique.

A

And now we've got an app. This app has instantiated our services, so we have a data service and we have a connection string and the whole point of hyper is to have a single connection string to access all these services or a single api.

A

So let's check our git pod it's up and running we're going to open a terminal in the hello world folder and in that we're going to go ahead and just bump up the font so that it's easier to read and I'm just going to change my prompt here. So I have more space.

A

A

Maybe yes, that's better! Okay, so um we want to take that connection string and add it to the app so first thing I'm going to do is initialize the app in the hello world folder by just calling yarn or you could call npm install if you want and then I'm going to go ahead and create a dot emv file and then I'm going to add hyper equals and let's just surround it by quotes, equals and then the connection string.

A

So I'm going to go to the dashboard and click on this document here to copy the connection string and then I'm going to paste it in here and with this echo command, I can use the greater than sign to put this in my emv file.

A

So now, if we go look at our emv, we've got hyper and we've got our connection string. So that's that's super cool. um So what we want to do in this workshop is again. We set up our hyper development and spirit uh environment. So that's that's awesome and we want to use hyper to create a mario character document.

A

So we set up the emv. We can run our server and I'm going to run it calling yarn start and that's going to run the server and it's going to run it on port 3000.

A

So if we go to our little remote monitor here, let's make that public and we can close that down and then um well. We can actually just click this little globe here and that's going to open it in the browser, and we can see that if we do a request on the root we get a json document with name equals. Mario wiki api super cool. Now we've got our server running. We can minimize that down here and then um look at this create character, so the create character. We want to um create this uh character.

A

Mario, this character document in our api and we've got a file called api. Slash, create character. This is an express app. So if we want to look at the server, we can see that this is just a basic express, app, nothing magical and we've just got two endpoints some post api characters and I get api characters by id. So those are the two functions we want to implement and they're in the files create dash character and get dash characters.

A

So if we open create character, we can see that we've got a function and it's sending a not implemented message. So, while we're doing that, let's go ahead and set up how we're going to call it and we're going to use a tool called hopscotch.io spelled with two t's hopscotch.io and it's just a simple. um You know kind of postmen like interface in the browser, and I can grab this url and paste it here and do a get.

A

And if everything works, we get mario's wiki api, which is cool, and what we want to do is do a post and we want to post to the api and the characters endpoint, and we want to send a body of type json and in that body I'm just going to go over to our readme and copy this example, and we'll just add that as our body super cool and then what we want to do is do a send now we're getting message not implemented because we haven't implemented our feature yet so now we're ready to implement it.

A

We're going to use a module called hyper connect.

A

So if we go to package json, we can see that we've added hyper connect already and we're going to use that to expose our hyper api in this create character, js, so import connect from hyper connect and now that we have the connect, we need to give it our connection string. So we're going to say, const piper equals connect, process.emb to grab the hyper connection, string from its environment variable and then we're going to instantiate the hyper connect client by calling open print close print.

A

You can have multiple instances in an app of particular services, so you could have in in the default is the default instance, so you could pass default in and that would be fine, but you could also have multiple instances there. So we've got that and now we just need to add our document. So we'll capture the result and we'll call away hyper.data.add.

A

And we'll grab from the request, the body.

A

And then we'll return the result, so you know the purpose of this is to really get you up and going quickly and get a feel for the hyper api, so in real world apps. Obviously you want to validate your your body before it comes in and before you write it to your database.

A

Okay, so that's it! That's all. We need to add data to hyper. If we go to hopscotch and we run our post now, we should get ok, true and an id of character. 1.. Now that we've got that in the database, let's make sure we can get it out. So with that we're going to implement, get character, so we'll say, get character on hello world and do the exact same thing: import, connect from hyper connect and then we'll create our hyper api by calling connect passing it. The connection string.

A

And then we'll instantiate, the library and now we'll call.

A

Await hyper.data.get and we'll grab the params.id from the request, object and then we'll send the response to the caller, like that and that's how we do a get in hyper data service.

A

So we go to hopscotch and we can change this to a get and change the api to api characters, character dash one, and that should be our get and if everything goes well, we get our document back, pretty cool.

A

So if we look at the readme now we just did the get character in the workshop and um here's a couple of curl examples that you can do or you can use hopscotch as well, either way they all work and yeah. Give that a try have some fun and then check out our next workshop, where we'll go deeper into the connect client for hyper thanks.