riprsa / shrt

A shortener. In Go

An URL Shortener

This project is my first attempt at a URL shortener. It's a simple web app that allows you to short any URL you want by API request. It's not perfect, but it's pretty good, I swear! It's also open source, so you can check out the code on this page.

Usage

Create a short URL

curl -X POST -H "Content-Type: application/json" -d '{"url":"example.com/mypath"}' https://s.x16.me/api/short

Get a short URL

curl -X POST -H "Content-Type: application/json" -d '{"short":"AAAAAA"}' https://s.x16.me/api/url

Redirect from a short URL

curl -IX GET https://s.x16.me/AAAAAA

shrt's Issues

Design Specification

This document serves as a basis for further development of the URL shortener project, outlining important requirements, assumptions and constraints.

Requirements

1. The API server accepts a request with a given URL to return a unique ID string representing the provided URL.
2. The API server by default accepts a request as a JSON object.
3. The API server by default returns a non-error response as a JSON object.
4. The API server returns the URL with host, path, query and fragment parts (per RFC 3986) in response to the ID string provided in the request.
5. A specific API endpoint is responsible for returning HTTP 302 redirect response to the URL associated with the ID in the request.

Assumptions

1. Invalid URL is validated server-side.
2. It is the client's responsibility to specify necessary protocol for the returned URL.
3. A specific API endpoint returns a HTTP 302 redirect when a valid ID stored earlier is requested as a path.

Example:

# `AAAAAA` maps to `example.com/somepath`
curl -IX GET https://s.x16.me/AAAAAA
HTTP/1.1 302 Found
Location: https://example.com/mypath

Constraints

1. Protocol (scheme) is not stored as a part of the provided URL.
2. Protocol (scheme) is not returned in the URL response.
3. User identification (the user:password@ part) is not stored in the provided URL.
4. User identification (the user:password@ part) is not returned in the URL response.
5. When HTTP 302 redirect is returned, only HTTPS protocol is used in the Location header of the response.

https://s.x16.me/ return conn busy

Because I use pgx.Conn, there are chances that the web site would return conn busy error.