concierge

README

➡️ Concierge

A tiny URL shortener API, written in Go.

I've been exploring Go with the intention of using it to build APIs and microservices, and this is a learning project to understand Go code structure, the Echo web framework, and GORM (a PostgreSQL ORM).

Concierge is a JSON-based REST API that takes a valid alias and returns the corresponding URL via a HTTP 301 redirect. There's also a management endpoint to create (or preview existing) records. Once records have been created, they cannot be removed or modified via the API.

API Endpoints

/ (Root)

• GET
  Returns documentation about the API and its listed endpoints.

/to/:alias (Link Redirection)

• GET - Requires a valid alias url-parameter.
  Returns a redirection (HTTP 301) response to the corresponding URL via HTTPS.

/link/ (Link Management)

• GET - Requires a valid alias query-parameter.
  Returns metadata about an existing alias entry, creation date, and the corresponding URL.

• POST - Requires valid alias and url query-parameters.
  If the alias is vacant, the API will confirm creation of the new record. Returns an error message if the alias is occupied.

Deployment Instructions

Concierge can be run as a Docker container and uses port 3000.
You can pull the container (abiddiscombe/concierge) from Docker Hub.

The server stores data in a PostgreSQL instance. The following environment variables are required to establish a connection to the database:

• CONCIERGE_PG_HOST - The PostgreSQL Host
• CONCIERGE_PG_PORT - The PostgreSQL Server Port
• CONCIERGE_PG_NAME - The PostgreSQL Database Name
• CONCIERGE_PG_USER - The PostgreSQL Connection Username
• CONCIERGE_PG_PASS - The PostgreSQL Connection Password