search

nixypanda / story-shot-backend

A POC app backend written in Haskell.
BSD 3-Clause "New" or "Revised" License
2 stars 1 forks source link

readme

Backend

The back-end for story-shot app written in Haskell.

Steps (You will need the haskell-stack on your machine):

  1. cd into the directory (backend).
  2. run stack setup.
  3. run stack build.
  4. run stack exec story-shot-exe.

Structure

API Docs

Endpoint Method Description
/ GET index route
/health GET health
/story POST
/story GET Batch request, supported query params: includes={author,tag}, next_cursor={Int}, size={Int}
/story/:id GET Single, supported query params: includes={author,tag}
/story/random GET get a random story, supported query params: includes={author,tag}
/story PUT edit multiple stories
/story/:id PUT edit a specific story
/story DELETE delete multiple stories Batch, supported query params: ids={Comma seperated Int}
/story/:id DELETE delete
/tag POST
/tag GET Batch request, supported query params: next_cursor={Int}, size={Int}
/tag/:id GET
/tag PUT
/tag/:id PUT
/tag DELETE delete multiple tags Batch, supported query params: ids={Comma seperated Int}
/tag/:id DELETE
/author POST
/author GET Batch request, supported query params: next_cursor={Int}, size={Int}
/author/:id GET
/author PUT
/author/:id PUT
/author DELETE delete multiple authors Batch, supported query params: ids={Comma seperated Int}
/author/:id DELETE
/user POST
/user GET Batch request, supported query params: includes={author}, next_cursor={Int}, size={Int}
/user/:id GET
/user PUT
/user/:id PUT
/user DELETE
/user/:id DELETE delete multiple users Batch, supported query params: ids={Comma seperated Int}

Todo