Site-Preview-API

Site Preview API is a link unfurling API that returns metadata of a website . The endpoint returns a parsed version of the html content of the url parsed and returns it in the form of a JSON Object

Frameworks used for the API

Nest JS https://nestjs.com/
Prisma database orm https://www.prisma.io/

🛠 Installation & Set Up

1. Install and use the correct version of Node using NVM

   nvm install

2. Install dependencies

   npm install

3. Start the development server

   npm run start:dev

Endpoints

 GET   http://localhost:4000/parse/?url

API Call

http://localhost:3000/parse/?url={url of website}

Code Examples :

http://localhost:4000/parse?url=https://nextjs.org/docs/api-routes/dynamic-api-routes

Query Parameters

url - required - This is the url that will be parsed to get the metadata with includes title,description and favicon of the website. start with https

Responses

Status and Errors

Status 200 = Success

Status 500 = Internal Server Error