https://github.com/jod35/userrestapi

A simple CRUD REST API
https://github.com/jod35/userrestapi

flask marshmallow rest-api

Last synced: about 1 month ago
JSON representation

A simple CRUD REST API

• Host: GitHub
• URL: https://github.com/jod35/userrestapi
• Owner: jod35
• Created: 2020-12-22T13:24:04.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-22T14:19:09.000Z (over 5 years ago)
• Last Synced: 2025-07-31T06:08:35.199Z (11 months ago)
• Topics: flask, marshmallow, rest-api
• Language: Python
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# User API

This is a simple REST API for users

# About the API

| ENDPOINT | HTTP VERB | ACTION |

|----------|-----------|--------|

|/users/   | GET       | get all users |

|/user/ID | GET       | get a single user by ID |

|/user/ID | PATCH    | update a user's info |

|/user/ID | DELETE  | delete a user  |

|/users/ |  POST   | create a new user |

### GET all users

```

[

 {"username":"user1",

   "email": "user1@test.com",

	 "password":"password"

 },

  {"username":"user2",

   "email": "user2@test.com",

     "password":"password"

   },  

]

```

That returns a list of resources

### GET a user by id

```

{"success":true,

  { "id":1

    "username":"user",

    "email":"user@test.com",

     "password":"password"

  }

}

```

This returns a user with an ID

### DELETE a user by ID

```

{

    "message": "User Deleted",

    "success": true,

    "user": {

        "email": "user@test.com",

        "id": 2,

        "password": "password",

        "username": "user"

    }

}

`i``