GithubHelp home page GithubHelp logo

workindia-noteapp's Introduction

WorkIndia-NoteApp

An API application that can create a Note and display all Notes of a user

Requirements:

User account registration: Create a user account. These credentials will be used to log into this panel.

[POST] /app/user

Request Data: { 'username': str, 'password': str }

Response Data: { 'status': 'account created' }

Curl command to test account registration:

curl -H 'Content-Type: application/json' -d '{"username": "","password":""}' -X POST http://127.0.0.1:8000/notesapp/user

User account login:

Provide the ability to log into the panel using the user credentials.

[POST] /app/user/auth

Request Data: { 'username': str, 'password': str }

Response Data: { 'status': 'success', 'userId': int }

Curl command to test user login:

curl -H 'Content-Type: application/json' -d '{"username": "","password":""}' -X POST http://127.0.0.1:8000/notesapp/auth.

List Saved Notes:

Provide list of stored notes for the logged-in user

[GET] /app/sites/list/?user={userId}

Request Data: None Response Data: [List of saved notes] The list returned should belong to the userId passed with the request

Curl command to test list the notes:

curl -H 'Content-Type: application/json' -X GET http://127.0.0.1:8000/notesapp/sites/list/

Save a new note:

Provide the ability for users to add a new note.

[POST] /app/sites?user={userId}

Request Data: { 'note': str, }

Response Data: { 'status': 'success' }

Curl command to test save the note:

curl -H 'Content-Type: application/json' -d '{"description":"Sudheer is here"}' -X POST http://127.0.0.1:8000/notesapp/sites/

workindia-noteapp's People

Contributors

ansul357 avatar

Watchers

James Cloos 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.