Giter VIP home page Giter VIP logo

build-sprint-secret-family-recipes-cookbook-reusable-be's Introduction

cookbook-BE

Secret Family Recipe Cookbook - Backend

Section Contents:

/auth/login POST

Expects an object with this format as the request body:

{
  "username": "User1",   //string
  "password": "password" //string
}

/auth/register POST

Expects an object with this format as the request body:

{
  "username": "User1",   //string
  "password": "password" //string
}

/recipes GET

Requires an authorization header with a JWT. it will return an array of objects in this format:

  "recipes": [
        {
            "id": 2,
            "user_id": 1,
            "title": "Pomello",
            "source": "Lester",
            "notes": "Re-engineered empowering workforce",
            "tags": [
                "pie",
                "seafood"
            ]
        },
        {
            "id": 7,
            "user_id": 1,
            "title": "Wine - Ej Gallo Sierra Valley",
            "source": "Winnie",
            "notes": "Function-based global attitude",
            "tags": [
                "soup",
                "desserts",
                "sandwich"
            ]
        }

/recipes POST

Requires an authorization header with a JWT. Expects an object with this format as the request body:

    {
        "title": "Pomello",
        "source": "Lester",
        "notes": "Re-engineered empowering workforce",
        "ingredients": [
            "Creme De Menth - White"
        ],
        "instructions": [
            "curabitur convallis duis consequat dui nec nisi volutpat eleifend",
            "venenatis lacinia aenean sit amet justo morbi ut odio cras"
        ],
        "tags": [
            "pie",
            "seafood"
        ]
    }

/recipes/:id GET

Requires an authorization header with a JWT. The object represents the recipe with the ID specified in the path:

  "recipe": {
        "id": 2,
        "user_id": 1,
        "title": "Pomello",
        "source": "Lester",
        "notes": "Re-engineered empowering workforce",
        "ingredients": [
            "Creme De Menth - White"
        ],
        "instructions": [
            "curabitur convallis duis consequat dui nec nisi volutpat eleifend",
            "venenatis lacinia aenean sit amet justo morbi ut odio cras"
        ],
        "tags": [
            "pie",
            "seafood"
        ]
    }

/recipes/:id PUT

Requires an authorization header with a JWT. Expects an object with this format as the request body:

    {
        "title": "Pomello",
        "source": "Lester",
        "notes": "Re-engineered empowering workforce",
        "ingredients": [
            "Creme De Menth - White"
        ],
        "instructions": [
            "curabitur convallis duis consequat dui nec nisi volutpat eleifend",
            "venenatis lacinia aenean sit amet justo morbi ut odio cras"
        ],
        "tags": [
            "pie",
            "seafood"
        ]
    }

/recipes/:id DELETE

Requires an authorization header with a JWT. Deletes the selected recipe if it exists and is associated with the current user.

build-sprint-secret-family-recipes-cookbook-reusable-be's People

Contributors

ken1286 avatar catslanderer avatar

Watchers

James Cloos avatar Austen Allred avatar B avatar Elissa Thomas avatar Brit Hemming avatar Soumya Ghosh avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.