Coder Social home page Coder Social logo

bitsy's Introduction

bitsy

A URL shortener for the CODEX community.

API Endpoints

GET/uri/all

GET request for all registered URL and their corresponding short URL and ID
Requires Authentication

Request Body

none

Response

Status Code Message Reason
200 All URI list The list of URLs shortened/registered
201 No URI regisitred No URLs has been shortened/registered
202 Error Occured Error Occured while shortening the URL

POST/user/login

POST request to login to the bitsy admin portal

Request Body

Feild Description Required
username The username of the CODEX admin True
password The password of the CODEX admin True

Response

Status Code Message Reason
200 Logged In Succesfully User logged in successfully

POST/user/logout

POST request to logout from the bitsy admin portal
Requires Authentication

Request Body

none

Response

Status Code Message Reason
200 Logged Out Succesfully User logged out successfully
210 Not Logged In User is not logged in

POST/new

POST request to register new URL for shortening
Requires Authentication

Request Body

Feild Description Required
uri The URL to be shortened True
shortUri The preferred short uri or empty string False

Response

Status Code Message Reason
200 URI Registered Successfully User logged out successfully
201 URI/ShortURI already registered The provided long URL alredy has a shortened URL
202 Error Occured Error Occured while shortening the URL
203 Invalid URI Invalid long URL was provided
205 Necessary Parameters Missing One or More of the required/essential parameter is/are missing
210 Not Logged In User is not logged in

POST/delete

POST request for deleteing an obselete registered URL
Requires Authentication

Request Body

Feild Description Required
_id The unique ID for the short URL True
shortUri The shortened URL True

Response

Status Code Message Reason
200 Deleted Successfully The short URL was deleted successfully
201 URI not found No such URL matches the provided ID and short URL
202 Error Occured Error Occured while shortening the URL
205 Necessary Parameters Missing One or More of the required/essential parameter is/are missing
210 Not Logged In User is not logged in

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.