news_api
所属分类：数据库系统
开发工具：Python
文件大小：0KB
下载次数：0
上传日期：2024-03-30 03:30:25
上 传 者：
sh-1993
说明： 使用Django、Django-REST、Postgresql和Angular并进行数据库优化的最新新闻仪表板
(Latest News Dashboard using Django, Django REST, Postgresql and Angular with Database Optimization)
文件列表:
news_backend/
Dockerfile
docker-compose.yml
init.sh
requirements
requirements.txt
# News_api
News web api using Django, Django REST, Postgresql and Angular with Database Optimization.
# Description
a web application with Django and Django REST framework as the backend to fetch
news from the News API, incorporating database optimizations.
# Structure
```
news_web_app/
|-- news_backend/ # Django Backend
| |-- news_app/ # Django App
| | |-- api/ # Rest API
| | | |-- __init__.py
| | | |-- urls.py
| | | |-- views.py
| | |-- migrations/
| | |-- __init__.py
| | |-- admin.py
| | |-- apps.py
| | |-- models.py
| | |-- serializers.py
| | |-- tasks.py # Celery task that fetches news data from the News API and updates Django model
| | |-- urls.py
| | |-- views.py
| |-- news_web_app/ # Django Project
| | |-- __init__.py
| | |-- celery.py # Celery configuraion
| | |-- settings.py
| | |-- urls.py
| | |-- wsgi.py
|-- frontend/ # Angular Frontend not implemented yet
|-- .env # To store NEWS_API_KEY and environemen vribales
|-- manage.py
|-- schema.yml # The genrated schema for Api documentation
```
# Setup
Clone project
```shell
$ https://github.com/madjid2714/news_api.git
```
```shell
$ cd news_api
```
install redis
```shell
sudo apt instal redis
```
Install requirement
```shell
$ pip install -r requirement.txt
```
enter to postgres:
```shell
$ sudo -u postgres psql
```
create datbase:
```sql
CREATE DATABASE newsdb;
```
cretae user with password:
```sql
CREATE USER admin WITH PASSWORD 'dbpassword';
```
setting the default encoding to utf-8 and time zone to utc, and default_transactions to read commited:
```sql
ALTER ROLE admin SET client_encoding TO 'utf8';
ALTER ROLE admin SET default_transaction_isolation TO 'read committed';
ALTER ROLE admin SET timezone TO 'UTC';
```
Configure database in django settings.py
```python
# Database
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'newsdb',
'USER': 'admin',
'PASSWORD':'dbpassword',
'HOST': 'localhost',
'PORT':'5432',
}
}
```
migrate databse :
```shell
$ python3 manage.py makemigrations
$ python3 manage.py migrate
```
create superuser:
```shell
$ python3 manage.py createsuperuser
```
Create the partitions using the command:
```shell
$ export DJANGO_SETTINGS_MODULE=news_backend.settings
$ architect partition --module news_app.models
architect partition: result: successfully (re)configured the database for the following models: NewsArticle
```
start the celery worker :
```shell
$ celery -A news_backend worker --loglevel=info
$ celery -A news_backend beat --loglevel=info
```
Generate schema.yml for API documentation :
```shell
$ python manage.py spectacular --color --file schema.yml
```
Go the newsapi.org/ and get NEWS_API_KEY and put the key in the .env file :
```env
# example
NEWS_API_KEY = '0ca3a3d9ad1e4fda96b59b4f80c2fcba'
```
run server and test the app:
```shell
$ python3 manage.py runserver
```
# Endpoints
List all news example : http://localhost:8000/api/all
country_retrieve : http://localhost:8000/api/category/?country=us
category_retrieve : http://localhost:8000/api/category/?category=technology
source_retrieve : http://localhost:8000/api/source/?source=IGN
# API documentation:
Swagger ui : http://localhost:8000/api/docs
Redoc ui : http://localhost:8000/api/redoc
近期下载者：
相关文件：
收藏者：