URL Shortener

URL Shortener is a simple web app and REST API based microservice designed to make it easy for users to shorten URLs using their custom domain name. Simply add a URL to the site and use the endpoint generated to be redirected. (Table of Contents below)

Going to an endpoint that is stored in the SQLite db will redirect the user to that URL.

For example, the below would redirect a user to example.com based on the above screenshot where example2 has example.com stored as the URL.

Table of Contents

• Usage
  • Start the server
  • Specify a port
  • Prepopulate database
  • Change the log timezone
  • Packages used
• Endpoints
  • GET /{endpoint}
  • GET /shortcuts
  • POST /shortcut
  • PUT /{endpoint}
  • DELETE /{endpoint}

Usage

This is a simple URL shortening app that allows users to create URL shortcuts using an API.

Simply copy these files into a directory and run go run main.go to start the server on localhost:8080

Start the server on localhost:8080

go run main.go

Going to an endpoint that is stored in the SQLite .db file generated will redirect the user to the URL stored

The above would redirect a user to google if GET /shortcuts contained:

{
    "shortcuts":[
      {"endpoint":"example1","url":"https://www.google.com"},
      {"endpoint":"example2","url":"https://example.com/"}
    ]
  }

You can view all the endpoints and URLs by calling GET /shortcuts. Full CRUD API documentation can be found here.

Specify a port:

• Default port: 8080

go run main.go -port_number 9090

Prepopulate database:

Specify a yaml file to prepopulate the database with

Example YAML file contents

- endpoint: "urlshort"
  url: "https://github.com/joshuabl97/urlShort#prepopulate-database"
- endpoint: "urlshort-inspo"
  url: "https://github.com/gophercises/urlshort"

Usage

// starts the server
 go run main.go -yaml_filepath example.yaml 

In the browser going to localhost:8080/urlshort would take you here to this section of the documentation.

Change the log timezone

Specify a timezone you would like the server to use for printing logs

Usage

// timezone only accepts official TZ identifiers
// i.e Etc/Greenwich
go run main.go -timezone America/New_York

Packages used:

• chi
• SQLite
• zerolog
• yaml.v2

Endpoints

GET /{endpoint}

Redirects you to the url where the endpoint is linked in the database (view all endpoints by calling GET /shortcuts)

• Endpoint: /{endpoint}
• Method: GET

Example Usage: In the browser go to an endpoint listed in shortcuts and it will redirect you to the URL i.e localhost:8080/example1 would bring you to google.com

GET /shortcuts

Get all the shortcuts available to be used by GET /{endpoint}

• Endpoint: /shortcuts

• Method: GET

• Response:

  {
    "shortcuts":[
      {"endpoint":"example1","url":"https://www.google.com"},
      {"endpoint":"example2","url":"https://example.com/"}
    ]
  }
  

Example Usage:

curl localhost:8080/shortcuts | jq

POST /shortcut

Creates a new shortcut available to be used by GET /{endpoint}

• If you do not specify an endpoint a random 5 character string will be generated instead
  • i.e {"url":"example.com"} would return something like {"endpoint": "jGw3a","url": "example.com"}

You can view all the endpoints and URLs by calling GET /shortcuts

• Endpoint: /shortcut
• Method: POST
• Parameters:
  • URL required
  • Content-Type: application/json

Parameter	Type	Description
endpoint	string	endpoint to be used in GET /{endpoint}
url	string	url that GET /{endpoint} will route you to

• Response:

  {  
      {"endpoint":"test","url":"https://godaddy.com"}
  }
  

Example Usage:

curl -X POST \
-H "Content-Type: application/json" \
-d '{"endpoint":"test","url":"https://godaddy.com"}' \
http://localhost:8080/shortcut

PUT /{endpoint}

Updates an existing shortcut available to be used by GET /{endpoint}

You can view all the endpoints and URLs by calling GET /shortcuts

• Endpoint: /{endpoint}
• Method: PUT
• Parameters:
  • required
  • Content-Type: application/json

Parameter	Type	Description
endpoint	string	endpoint to be used in GET /{endpoint}
url	string	the url you would like to replace

Example Usage:

curl -X PUT \
-H "Content-Type: application/json" \
-d '{"endpoint":"example1","url":"https://anotherSite.com"}' \
http://localhost:8080/shortcut

DELETE /{endpoint}

Deletes an endpoint stored in the database

You can view all the endpoints and URLs by calling GET /shortcuts

• Endpoint: /{endpoint}
• Method: DELETE

Example Usage:

curl -X DELETE localhost:8080/example1