Giter VIP home page Giter VIP logo

person_crud's Introduction

Person API

Description

The Person API allows you to manage and retrieve information about a person, including their name, age, and email addresse.

Table of Contents

Getting Started

Follow the instructions below to get the Person API up and running on your local machine.

Prerequisites

  • Python 3.9 or higher
  • Django 3.2 or higher
  • Django REST Framework 3.12 or higher

Installation

  1. Clone the repository:
    git clone https://github.com/your-username/person-api.git
  2. Change into the project directory:
    cd person-api
  3. Create and activate a virtual environment: hange into the project directory:
    python3 -m venv venv
    source venv/bin/activate
  4. Install the required dependencies:
    pip install -r requirements.txt
  5. Apply database migrations:
    python manage.py migrate

Usage

Starting the API

  1. Run the following command to start the API:
    python manage.py runserver
  2. The API will be accessible at https://endpoint-dez.onrender.com/api/

API Endpoints

  • POST /api/: Creates a new person.
  • GET /api/{id}/: Retrieves a specific person by their id.
  • PUT /api/{id}/: Updates an existing person.
  • DELETE /api/{id}/: Deletes a person.

Please refer to the API documentation or interact with the API using tools like Postman to explore these endpoints in detail. Use this to link to access the test script on postman: https://documenter.getpostman.com/view/25680408/2s9YC1XuMF

NB:

  • Lastly, images for the UML and ER Diagram are in root directory with the base name person

person_crud's People

Contributors

dezzy12 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.