Sample Go project on Github

Creating a sample Github Go project

This tutorial will go through the steps required to establish your first, green field API Golang project on Github.

The objective is to have your own API server that provides routes for:

a. Health check b. Metrics c. Displaying an Australian BSB details d. Searching for a BSBs by bank and suburb

The official Australian BSB lookup site is https://bsb.auspaynet.com.au/public/BSB_DB.NSF/publicBSB.xsp

The end result API server is not optimised for heavy production use but does demonstrate the Qaskx-cli process for building an API server using an OpenAPI definition and other upstream data.

The pre-requisites for starting the tutorial are:

  1. Golang 1.18 or later is installed on your local device
  2. Git is installed on your local device
  3. Github account and access token
  4. qaskx-cli command is installed and in your path

It is recommended you also have an IDE installed with suport for Golang.

If you have a self hosted GitHub or Gitea compatible site then the same instructions will work. Please ensure that our default GitProvider (GitHub or Gitea) is set.

Start here to begin.

Note: This tutorial has been written and tested on a Windows 10 laptop.

BSB stands for Bank State Branch and is a six digit number that identifies banks and branches in Australia. BSB numbers are used to route domestic payments within Australis to the right bank accounts.

More recently the NPP has become a better alterntive for consumer to route domestic payments as it does not require knowloedge of bank account numbers, just a registered email address, mobile phone number or ABN.

For more details on Australian BSB, you are referred to https://www.auspaynet.com.au/