Skip to content

ammipw/API_design

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 

Repository files navigation

Neighbourhood API

Description

API working with Express JS and sending response via JSON format

api

Installation

Usage

Call the API using these endpoints:

Path HTTP Verb Action
/search GET index
/search/person/:name GET
/search/address/:postcode GET
/search/house/:houseName GET
/search/neighbors?age&numOfHouseHold GET

Examples for response:

It response in json format:

1- Req: get(/search/person/:name)

 Res: {
        name: "Micheal",
        age: 23,
        numberOfHouseHold: 2,
        postcode: "2xb 11wr"
      }

2- Req: get(search/address/:postcode)

  Res: {
          buildingName: "New Court",
          buildingNumber: 23,
          numberOfHousehold: 15
       }

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •