Giter VIP home page Giter VIP logo

backend_task_true_value_accessllp's Introduction

Backend

,

Deployed on pythonanywhere:

Include Swagger Documentation: https://truevalue.pythonanywhere.com

Run Locally

Clone the project

  https://github.com/icerahi/backend_task_true_value_accessLLP project

Install dependencies and setup project

Go to project backend directory and write

  cd project
  virtualenv -p python3 venv 
  source venv/bin/activate
  pip install -r requirements.txt
  python manage.py makemigrations
  python manage.py migrate 
  python manage.py runserver

Running Tests

To run tests, run the following command

  python manage.py test

API Reference

Get all users

  GET /api/users/

Response with HTTP status code 200 on success

Query Parameter Type Example
page integer /api/users/?page=3
limit integer /api//users/?limit=10
name string /api/users/?name=james
sort string /api/users/?sort=-age

Create a new user

  POST /api/users/
body/required attributes format status
id,first_name,last_name,company_name,city,state,zip,email,web,age json 201 on success

example:

{
"id": 2,
"first_name": "Josephine",
"last_name": "Darakjy",
"company_name": "Chanay, Jeffrey A Esq",
"city": "Brighton",
"state": "MI",
"zip": 48116,
"email": "[email protected]",
"web": "http://www.chanayjeffreyaesq.com",
"age": 48
} 

Get user

  GET /api/users/<id>
Path Parameter Type Example status
id int /api/users/1 200 on success

Update user

  PUT /api/users/{id}
Path Parameter Type body/required attributes/format=json status
id int first_name,last_name,age 200 on success

Delete a user

 DELETE /api/users/{id}
Path Parameter Type status
id int 200 on success

Authors

backend_task_true_value_accessllp's People

Contributors

icerahi avatar

Watchers

 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.