Giter Site home page Giter Site logo

goshort's Introduction

URL shortner API server

Golang URL shortener API server

image

Getting started

Prerequisites

Configuration

Add the file .env to the repository, and set the required environment variables:

RDS_ADDR=<redis-server address>
RDS_USER=<redis-username>
RDS_PWD=<redis-password>

Run with docker-compose

$ docker-compose up

Usage

  • GET /api/shorten

    Request Field Type Description
    longUrl string URL to be shorten
    Response Field Type Description
    shortUrl string The shorten URL

    example:

    curl --request GET "localhost:8080/shorten?longUrl=$longUrl"
    
  • GET /api/expand

    Request Field Type Description
    shortUrl string The short URL
    Response Field Type Description
    longUrl string Original URL

    example:

    curl --request GET "localhost:8080/api/expand?shortUrl=$shortURL"
    

TODOs

There are some features plan to be done in the future:

  • Handle duplicated key/url
  • Caching

goshort's People

Contributors

tinwech avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.