/catchphrase-go-mongodb-rest-api

A REST API built with Fiber (Go) and MongoDB. This API provides movie catchphrases and the context of the catchphrase in the movie. (Tutorial)

Primary LanguageGo

Catchphrase Fiber (Go) and MongoDB REST API

An API built with Fiber and MongoDB.

Tutorial available at: dev.to

API Usage

Get all catchphrases

  GET /catchphrases
Optional Parameter Type Description Example
s string Serach Movie Name or Catchphrase ?s=exmpletext
page int Page number. Default: 1 ?page=2
limit int Limit number of catchphrases per page. Default: 10 ?limit=20

Get catchphrase

  GET /catchphrases/:id
Parameter Type Description
id string Required. Id of catchphrase to fetch

Add catchphrase

  POST /catchphrases
{
	"movieName": "AUSTIN POWERS: INTERNATIONAL MAN OF MYSTERY",
	"catchphrase": "Yeah baby, yeah!",
	"movieContext": "Austin Powers, conversing with his partner, Mrs. Kensington"
}

Update catchphrase

  PATCH /catchphrases/:id
Parameter Type Description
id string Required. Id of catchphrase to update 
{
	"movieName": "AUSTIN POWERS: INTERNATIONAL MAN OF MYSTERY",
	"catchphrase": "Yeah baby, yeah!",
	"movieContext": "Austin Powers, conversing with his partner, Mrs. Kensington"
}

// All three fields are optional when updating

Remove catchphrase

  DELETE /catchphrases/:id
Parameter Type Description
id string Required. Id of catchphrase to delete

Links

Tutorial