Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steppacodes/contacts-api
A contacts api built using django rest framework
https://github.com/steppacodes/contacts-api
Last synced: about 11 hours ago
JSON representation
A contacts api built using django rest framework
- Host: GitHub
- URL: https://github.com/steppacodes/contacts-api
- Owner: SteppaCodes
- Created: 2024-01-06T16:49:40.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-03T16:58:15.000Z (8 months ago)
- Last Synced: 2024-03-03T20:42:07.676Z (8 months ago)
- Language: JavaScript
- Homepage: https://steppa-contacts-api.vercel.app/api/v1/
- Size: 1.96 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contacts-API
A contacts api built using django rest framework
# Features
- Authentication: Implements token-based authentication to fortify the API against unauthorized access. Utilizing DRF's authentication classes, i ensure secure communication between clients and the API
- User Email OTP Verification: Implemented email verification using one-time passwords (OTPs). When users register their email addresses, a unique OTP is generated and sent to their email. Users can verify their email addresses by submitting the OTP they receive. This enhances account security and ensures valid email addresses.
- CRUD Operations: Leverages the power of Django Rest Framework to seamlessly perform Create, Read, Update, and Delete operations on contacts, groups and favourites.
- Paginated Response: leveraging the robust capabilities of Django Rest Framework's Pagination class to seamlessly deliver paginated responses for all endpoints returning multiple objects. By implementing pagination, users can efficiently retrieve a specified number of data per response, thereby minimizing query time and significantly boosting overall performance
- Alphabetical ordering for contact list results, enhancing user experience and making it easier to locate contacts by name
- Prioritizing Favourite Contacts: Users can mark certain contacts as favourites, allowing them to easily access and prioritize important information.
- Contact Grouping: Organizing contacts into groups or categories to streamline navigation and enhance organization.
# Testing API
To test the functionality of the api, you can use the following login credentials to be authorized:
- email: [email protected]
- password: testuser
# Installation Guide
- Download or clone this repostory using
```sh
git clone [email protected]:SteppaCodes/Contacts-API.git
- Navigate into your project directory
```sh
cd contacts-api
- Create a virtual environment
```sh
python -m venv env
- Activate the virtual environment
- On Windows:
```sh
env\scripts\activate
- On Macos:
```sh
source env/bin/activate
- Install dependencies
```sh
pip install -r requirements.txt
- Run migrations to setup initial database schema
```sh
python manage.py migrate
- Create super user(optional)
```sh
python manage.py createsuperuser
- Run the development server
```sh
python manage.py runserver
- Access the API: on your browser, navigate to
``` sh
http://127.0.0.1:8000/api/v1/
# Authentication
Token-based authentication is used to secure the API endpoints. To access protected endpoints, include the token in the request headers:
# Permissions
Permissions are implemented to control access to the API endpoints. By default, only authenticated users can access the endpoints. You can customize permissions according to your requirements.
Congratulations! You've successfully set up the Contacts API. If you encounter any issues or have any questions, feel free to reach out to me. Happy coding! 🚀