Go - Api.Get()

This method is a convenient short version of Api.Route.Get()

import (
  "fmt"

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

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

  api.Get("/hello", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
    ctx.Response.Body = []byte("Hello World")
    return next(ctx)
  })

  nitric.Run()
}

Parameters

Name
match
Required
Required
Type
string
Description
The path matcher to use for the route. Matchers accept path parameters in the form of a colon prefixed string. The string provided will be used as that path parameter's name when calling middleware and handlers. See create a route with path params.
Name
middleware
Required
Required
Type
HttpMiddleware
Description
The middleware function to use as the handler for HTTP requests. If you want to compose more than one middleware use faas.ComposeHttpMiddleware.
Name
options
Optional
Optional
Type
...MethodOption
Description
Additional options for the route. See below.

Method options

Name
WithNoMethodSecurity()
Optional
Optional
Type
MethodOption
Description
Sets a base path for all the routes in the API.
Name
WithMethodSecurity()
Optional
Optional
Type
MethodOption
Description
Overrides a security rule from API defined JWT rules.
Name
name
Required
Required
Type
string
Description
The name of the security rule.
Name
scopes
Required
Required
Type
[]string
Description
The scopes of the security rule.

Examples

Register a handler for GET requests

api.Get("/hello", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  ctx.Response.Body = []byte("Hello World")
  return next(ctx)
})

Create a route with path params

api.Get("/hello/:name", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  name := ctx.Request.PathParams()["name"]
  ctx.Response.Body = []byte("Hello " + name)
  return next(ctx)
})

Create a route with no method security

import (
  "fmt"

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

func main() {
  secureApi, err := nitric.NewApi(
    "secure",
    nitric.WithSecurityJwtRule("user", nitric.JwtSecurityRule{
      Issuer: "https://example-issuer.com",
      Audiences: []string{ "YOUR-AUDIENCES" },
    }),
    nitric.WithSecurity("user", []string{"products:read"}),
  )
  if err != nil {
    return
  }

  // Override the APIs security requirements with `WithNoMethodSecurity()`
  api.Get("/public", func(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
    // Handle request
    return next(ctx)
  }, nitric.WithNoMethodSecurity())

  nitric.Run()
}

Chain functions as a single method handler

When multiple functions are provided they will be called as a chain. If one succeeds, it will move on to the next. This allows middleware to be composed into more complex handlers.

import (
  "fmt"

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

func authMiddleware(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  // Perform auth validation
  return next(ctx)
}

func handleRequest(ctx *faas.HttpContext, next faas.HttpHandler) (*faas.HttpContext, error) {
  name := ctx.Request.PathParams()["name"]
  ctx.Response.Body = []byte("Hello " + name)
  return next(ctx)
}

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

  api.Get("/hello/:name", faas.ComposeHttpMiddleware(authMiddleware, handleRequest))

  nitric.Run()
}