Categorygithub.com/mikefmeyer/catchphrase-go-mongodb-rest-api
modulepackage
0.0.0-20231017130156-6411f4be76b3
Repository: https://github.com/mikefmeyer/catchphrase-go-mongodb-rest-api.git
Documentation: pkg.go.dev

# README

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 ParameterTypeDescriptionExample
sstringSerach Movie Name or Catchphrase?s=exmpletext
pageintPage number. Default: 1?page=2
limitintLimit number of catchphrases per page. Default: 10?limit=20

Get catchphrase

  GET /catchphrases/:id
ParameterTypeDescription
idstringRequired. 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
ParameterTypeDescription
idstringRequired. 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
ParameterTypeDescription
idstringRequired. Id of catchphrase to delete

Links

Tutorial

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author