API design

Define what APIs are expected from the system...

Success Response: {

data: {

url: "abc.ly/xu3isf1"

},

status: 200, //status code is be according to the API response

message: "success",

error: {}

}

Error Response: {

data: {},

status: 412, //status code is be according to the API response

message: "validation failed",

error: {

code: 412,

message: "URL is invalid format"

}

}

Generate URL: v1/url POST
1. API will take 2 parameters
  1. URL (required)
  2. expiration (optional)
2. API will validate the URL is valid URL format
3. API will validate the URL duplication entry
4. API will generate the unique short URL
5. API will return the response in standard format containing shorten URL
GET All URL: v1/url GET
1. API will fetch all valid URL's from system
2. API will contain pagination meta data
3. API will send the response based on the pagination flow
GET Single URL: v1/url/{id} GET
1. API will fetch the URL based on the provided ID
2. API will send standard response containing URL and its information
DELETE URL: v1/url/{id} DELETE
1. API will fetch the URL based on the provided ID
2. API will soft delete the URL of the provided ID
3. API will send standard success response
Redirect URL: GET
1. API will take 1 query param
  1. code
2. API will find the corresponding long URL associated with the code
3. API will validate its expiration
4. API will increase the count
5. API will return the original long URL