DEV Community

Cover image for Your first API with GO & Nitric
Rak
Rak

Posted on • Edited on

Your first API with GO & Nitric

#go #cloudcomputing #tutorial #productivity

Hey Dev.to community!

Today we are diving into an exciting project where we'll create a Profile Management API using Nitric and GO.

This API will handle the creation, updating, and deletion of user profiles. We’ll then extend it to manage profile images.

  1. Use Nitric to create an API to create and update profiles
  2. Create handlers for the following API operations
Method Route Description
GET /profiles/[id] Get a specific profile by its Id
GET /profiles List all profiles
POST /profiles Create a new profile
DELETE /profiles/[id] Delete a profile
PUT /profiles/[id] Update a profile
  1. Run locally for testing
  2. Deploy to a cloud of your choice
  3. (Optional) Add handlers for the following API operations
Method Route Description
GET /profiles/[id]/image/upload Get a profile image upload URL
GET profiles/[id]/image/download Get a profile image download URL
GET profiles/[id]/image/view View the image that is downloaded

Prerequisites

Introducing Nitric

Nitric is a tool that helps developers create applications for the cloud (like AWS, Google Cloud, or Microsoft Azure) quickly and with less repetitive code. It acts as a bridge between your code and the cloud services, making it dead simple to build and deploy your application.

By using Nitric, you can focus more on building your application, and less on the specifics of the cloud provider and eliminate the Terraform (or other IaC) project required to deploy it.

Learn more about it by checking out some of my other blogs, or heading to the docs.

Let's Code

We'll start by creating a new project for our API.

nitric new
Enter fullscreen mode Exit fullscreen mode

Create a project, name it and select your preferred starter template.

? What is the name of the project? my-profile-api
? Choose a template: official/Go - Starter
Enter fullscreen mode Exit fullscreen mode

Next, open the project in your editor of choice.

cd my-profile-api
Enter fullscreen mode Exit fullscreen mode

Make sure all dependencies are resolved:

go mod tidy
Enter fullscreen mode Exit fullscreen mode

The scaffolded project should have the following structure:

+--functions/
|  +-- hello/
|      +-- main.go
|  ...
+--nitric.yaml
+--go.mod
+--go.sum
+--.gitignore
+--README.md
Enter fullscreen mode Exit fullscreen mode

You can test the project to verify everything is working as expected:

nitric start
Enter fullscreen mode Exit fullscreen mode

and in a separate terminal:

go run functions/hello
Enter fullscreen mode Exit fullscreen mode


The first command starts the Nitric Server using nitric start, which
provides local interfaces to emulate cloud resources. Then go run
functions/hello runs your functions and allows them to connect.

If everything is working as expected you can now delete all files in the functions/ folder, we'll create new functions in this guide.

Building the Profile API

Let's start building the profiles API. Create a file named main.go in the functions directory and add the following:

package main

import (
  "fmt"

  "github.com/nitrictech/go-sdk/nitric"
)

func main() {
  profilesApi, err := nitric.NewApi("public")
  if err != nil {
    return
  }

  profiles, err := nitric.NewCollection("profiles").With(nitric.CollectionReading, nitric.CollectionWriting)
  if err != nil {
    return
  }

  if err := nitric.Run(); err != nil {
    fmt.Println(err)
  }
}
Enter fullscreen mode Exit fullscreen mode

Here we're creating:

  • An API named public,
  • A collection named profiles and giving our function permission to read and write to that collection.

From here, let's add some features to that function that allow us to work with profiles.


You could separate some or all of these request handlers into their own
functions if you prefer. For simplicity we'll group them together in this
guide.

Create profiles with POST 

profilesApi.Post("/profiles", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  id := uuid.New().String()

  var profileRequest map[string]interface{}
  err := json.Unmarshal(ctx.Request.Data(), &profileRequest)
  if err != nil {
    return ctx, err
  }

  err = profiles.Doc(id).Set(ctx.Request.Context(), profileRequest)
  if err != nil {
    return ctx, err
  }

  ctx.Response.Body = []byte(id)

  return ctx, nil
})
Enter fullscreen mode Exit fullscreen mode

Retrieve a profile with GET 

profilesApi.Get("/profiles/:id", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  id := ctx.Request.PathParams()["id"]

  profile, err := profiles.Doc(id).Get(ctx.Request.Context())
  if err != nil {
    ctx.Response.Status = 404
    ctx.Response.Body = []byte(fmt.Sprintf("profile with id '%s' not found", id))

    return ctx, nil
  }

  ctx.Response.Body, err = json.Marshal(profile.Content())

  return ctx, err
})
Enter fullscreen mode Exit fullscreen mode

List all profiles with GET 

profilesApi.Get("/profiles", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  profiles, err := profiles.Query().Fetch(ctx.Request.Context())
  if err != nil {
    return ctx, err
  }

  var profileContent []map[string]interface{}
  for _, doc := range profiles.Documents {
    profileContent = append(profileContent, doc.Content())
  }

  ctx.Response.Body, err = json.Marshal(profileContent)

  return ctx, err
})
Enter fullscreen mode Exit fullscreen mode

Remove a profile with DELETE 

profilesApi.Delete("/profile/:id", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  id := ctx.Request.PathParams()["id"]

  err := profiles.Doc(id).Delete(ctx.Request.Context())
  if err != nil {
    ctx.Response.Status = 404
    ctx.Response.Body = []byte(fmt.Sprintf("profile with id '%s' not found", id))

    return ctx, nil
  }

  return ctx, nil
})
Enter fullscreen mode Exit fullscreen mode

Ok, let's run this thing!

Now that you have an API defined with handlers for each of its methods, it's time to test it locally.

nitric start
Enter fullscreen mode Exit fullscreen mode

and in a separate terminal:

go run functions/hello
Enter fullscreen mode Exit fullscreen mode

Once it starts, the application will receive requests via the API port. You can use cURL, Postman or any other HTTP client to test the API.

We will keep it running for our tests. If you want to update your functions, just save them, they'll be reloaded automatically.

Test your API

Update all values in brackets [] and change the URL to your deployed URL if you're testing on the cloud.

Create Profile 

curl --location --request POST 'http://localhost:4001/profiles' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "name": "Peter Parker",
    "age": "21",
    "homeTown" : "Queens"
}'
Enter fullscreen mode Exit fullscreen mode

Fetch Profile 

curl --location --request GET 'http://localhost:4001/profiles/[id]'
Enter fullscreen mode Exit fullscreen mode

Fetch All Profiles 

curl --location --request GET 'http://localhost:4001/profiles'
Enter fullscreen mode Exit fullscreen mode

Delete Profile 

curl --location --request DELETE 'http://localhost:4001/profiles/[id]'
Enter fullscreen mode Exit fullscreen mode

Deploy to the cloud

At this point, you can deploy what you've built to any of the supported cloud providers. To do this start by setting up your credentials and any configuration for the cloud you prefer:

Next, we'll need to create a stack. A stack represents a deployed instance of an application, which is a collection of resources defined in your project. You might want separate stacks for each environment, such as stacks for dev, test and prod. For now, let's start by creating a dev stack.

nitric stack new
Enter fullscreen mode Exit fullscreen mode 
? What do you want to call your new stack? dev
? Which Cloud do you wish to deploy to? aws
? select the region us-east-1
Enter fullscreen mode Exit fullscreen mode

AWS

Note: You are responsible for staying within the limits of the free tier or any costs associated with deployment.

We called our stack dev, let's try deploying it with the up command

nitric up
┌───────────────────────────────────────────────────────────────┐
| API  | Endpoint                                               |
| main | https://XXXXXXXX.execute-api.us-east-1.amazonaws.com   |
└───────────────────────────────────────────────────────────────┘
Enter fullscreen mode Exit fullscreen mode

When the deployment is complete, go to the relevant cloud console and you'll be able to see and interact with your API.

To tear down your application from the cloud, use the down command:

nitric down
Enter fullscreen mode Exit fullscreen mode

Optional - Add profile image upload/download support

If you want to go a bit deeper and create some other resources with Nitric, why not add images to your profiles API.

Access profile buckets with permissions

Define a bucket named profilesImg with reading/writing permissions

profileImages, err := nitric.NewBucket("profileImages").With(nitric.BucketReading, nitric.BucketWriting)
if err != nil {
  fmt.Println(err)
  return
}
Enter fullscreen mode Exit fullscreen mode

Get a URL to upload a profile image 

profilesApi.Get("/profiles/:id/image/upload", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  id := ctx.Request.PathParams()["id"]
  photoId := fmt.Sprintf("images/%s/photo.png", id)

  photoUrl, err := profileImages.File(photoId).UploadUrl(ctx.Request.Context(), 600)
  if err != nil {
    return ctx, err
  }

  ctx.Response.Body = []byte(photoUrl)

  return ctx, nil
})
Enter fullscreen mode Exit fullscreen mode

Get a URL to download a profile image 

profilesApi.Get("/profiles/:id/image/download", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  id := ctx.Request.PathParams()["id"]
  photoId := fmt.Sprintf("images/%s/photo.png", id)

  photoUrl, err := profileImages.File(photoId).DownloadUrl(ctx.Request.Context(), 600)
  if err != nil {
    return ctx, err
  }

  ctx.Response.Body = []byte(photoUrl)

  return ctx, nil
})
Enter fullscreen mode Exit fullscreen mode

You can also directly redirect to the photo URL.

profilesApi.Get("/profiles/:id/image/view", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  id := ctx.Request.PathParams()["id"]
  photoId := fmt.Sprintf("images/%s/photo.png", id)

  photoUrl, err := profileImages.File(photoId).DownloadUrl(ctx.Request.Context(), 600)
  if err != nil {
    return ctx, err
  }

  ctx.Response.Status = 303
  ctx.Response.Headers["Location"] = []string{photoUrl}

  return ctx, nil
})
Enter fullscreen mode Exit fullscreen mode

Time to test the updated API

Update all values in brackets [] and change the URL to your deployed URL if you're testing on the cloud.

Get an image upload URL 

curl --location --request GET 'http://localhost:4001/profiles/[id]/image/upload'
Enter fullscreen mode Exit fullscreen mode

Using the upload URL with curl 

curl --location --request PUT '[url]' \
--header 'content-type: image/png' \
--data-binary '@/home/user/Pictures/photo.png'
Enter fullscreen mode Exit fullscreen mode

Get an image download URL 

curl --location --request GET 'http://localhost:4001/profiles/[id]/image/download'
Enter fullscreen mode Exit fullscreen mode

Wrapping Up

In this exploration, we created a Profile Management API using Nitric, handled core profile operations, and extended it for image management.

Nitric proves to be a reliable companion in swiftly moving from idea to a live, cloud-hosted API. Now it's your turn to expand this project or embark on new adventures with Nitric.

Happy coding!

This post originally featured on the Nitric website.

Top comments (2)

Collapse
 
marcello_h profile image
Marcelloh •

What I miss in this , is where the data is stored. It would also have been better if this wasn't a 1on1 copy, but let's say a TODO version (like a todo backend)

Collapse
 
rsiv profile image
Rak •

Thanks for the feedback - I'm happy to try a TODO style tutorial in the future!

I'll add some notes about how the collections object works to help clarify where the data is stored!

Read next

mdarifulhaque profile image

Build a Simple Auto-Play Carousel with Clickable Controls Using Alpine.js

MD ARIFUL HAQUE -

madza profile image

9 Open Source Projects Every Developer Needs to Bookmark 📚👨‍💻

Madza -

madza profile image

12 Useful Developer Tools You Will Wish You Knew Sooner 🧑‍💻🧙

Madza -

clericcoder profile image

Mastering Trace Analysis with Span Links using openTelemetry and Signoz (A Practical Guide,Part 2)

Abdulsalaam Noibi -