Django-carrierAPI is a RESTful API designed for user authentication and sending blog and career data. Built with Django, Django Rest Framework, and Python, this API serves responses when called by clients, providing seamless integration with various applications and services.
-
User Authentication
- Secure user authentication system to manage user access.
- Supports token-based authentication for API requests.
-
Blog and Career Data
- Provides endpoints to retrieve and manage blog and career-related data.
- Allows clients to fetch information about blogs and careers for display or analysis.
-
RESTful API
- Built following RESTful principles for standardized communication.
- Utilizes HTTP methods such as GET, POST, PUT, and DELETE for CRUD operations.
- Django: High-level Python web framework for rapid development and clean design.
- Django Rest Framework: Toolkit for building Web APIs in Django.
- Python: Programming language used for backend development.
-
Clone the repository:
git clone https://github.com/EnthusiasticXcoder/Django-carrierAPI.git
-
Change to the project directory:
cd Django-carrierAPI -
Install dependencies:
pip install -r requirements.txt
-
Environment Variables:
To run this project, you will need to add the following environment variables to your .env file
-
SECRET_KEY: SECRET_KEY of your Django Project. -
DEBUG: DEBUG value True or False
-
-
Run the development server:
python manage.py runserver
| Endpoint | Method | Description | Data | Authorization Token |
|---|---|---|---|---|
| /user/register | POST |
Register a new user. | first_name, last_name, email, username, password | No |
| /user/login | POST |
User login. | username, password | No |
| /user/ | GET |
Retrieve the user with the help of Token. | Yes | |
| /user/ | PUT |
Update password of a user with the help of Token. | password | Yes |
| /user/ | DELETE |
Delete a user with the help of Token. | Yes | |
| /blog/menu | GET |
Retrieve a list of available careers Data. | No | |
| /blog/list | GET |
Retrieve a list of all blogs of HomePage. | No | |
| /blog/list | POST |
Retrieve a list of all blogs of Particular career option. | url | No |
| /blog/content | POST |
Retrieve content of a specific blog by URL. | url | No |
- Access the API endpoints using your preferred HTTP client or tools like Postman.
- Refer to the API documentation or codebase for available endpoints and usage instructions.
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with descriptive commit messages.
- Push your changes to your forked repository.
- Submit a pull request to the main repository.
This project is licensed under the MIT License. See the LICENSE file for more details.
- Django: High-level Python web framework for rapid development and clean design.
- Django Rest Framework: Toolkit for building Web APIs in Django.