Skip to content

Just a simple api on express to provide summary on any topics

Notifications You must be signed in to change notification settings

Sonu-Hansda/wiki_express

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Wiki Express

An API build on express JS to fetch a short summary on any topic .

API Reference

Searching for any topic

Here you can search for anything , this will return the topics name.

  GET /search?topic={query}
Parameter Type Description
query string Required.

Getting short summary of a topic

Here you have to search for topic with proper spellings , for this first hit /search endpoint then get all topics name then search from there. This will return the short summary of that topic

  GET /summary?topic=${query}
Parameter Type Description
query string Required. Name of the topic

Run Locally

Clone the project

  git clone https://github.com/Sonu-Hansda/wiki_express

Go to the project directory

  cd wiki_express

Install dependencies

  npm install

Start the server

  npm run dev

About

Just a simple api on express to provide summary on any topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published