Shulou(Shulou.com)06/02 Report--

This article is about how to write a Python Web API with Django. The editor thinks it is very practical, so share it with you as a reference and follow the editor to have a look.

Django is the most comprehensive and popular of all Web frameworks. Since 2005, its popularity has increased significantly.

Django is maintained by the Django Software Foundation and has strong support from the community, with more than 11600 members worldwide. On Stack Overflow, there are about 191000 issues with Django tags. Spotify, YouTube, Instagram, and others all use Django to build applications and data management.

This article demonstrated a simple API that allows you to use the GET method of the HTTP protocol to get data from the server.

Build a project

First, create a directory structure for your Django application, which you can create anywhere on the system:

$mkdir myproject$ cd myproject

Then, create a virtual environment in the project directory to isolate local package dependencies:

$python3-m venv env$ source env/bin/activate

On Windows, use the command env\ Scripts\ activate to activate the virtual environment.

Install Django and Django REST framework

Then, install the Django and Django REST modules:

$pip3 install django$ pip3 install djangorestframework instantiates a new Django project

Now that your application has a working environment, you must instantiate a new Django project. Unlike micro-frameworks like Flask, Django has special commands to create (note after the first command. Characters).

$django-admin startproject tutorial. $cd tutorial$ django-admin startapp quickstart

Django uses the database to manage the backend, so you should synchronize the database before starting development. The database can be managed through a manage.py script, which is created when you run the django-admin command. Because you are now in the tutorial directory, run the script using the.. / symbol, which is located in the upper directory:

$python3.. / manage.py makemigrationsNo changes detected$ python4.. / manage.py migrateOperations to perform: Apply all migrations: admin, auth, contenttypes, sessionsRunning migrations: Applying contenttypes.0001_initial... OK Applying auth.0001_initial... OK Applying admin.0001_initial... OK Applying admin.0002_logentry_remove_auto_add... OK Applying admin.0003_logentry_add_action_flag_choices... OK Applying contenttypes.0002_remove_content_type_name... OK Applying auth.0002_alter_permission_name_max_length... OK Applying auth.0003_alter_user_email_max_length... OK Applying auth.0004_alter_user_username_opts... OK Applying auth.0005_alter_user_last_login_null... OK Applying auth.0006_require_contenttypes_0002... OK Applying auth.0007_alter_validators_add_error_messages... OK Applying auth.0008_alter_user_username_max_length... OK Applying auth.0009_alter_user_last_name_max_length... OK Applying auth.0010_alter_group_name_max_length... OK Applying auth.0011_update_proxy_permissions... OK Applying sessions.0001_initial... OK creates users in Django

Create an initial user named admin with a sample password of password123:

$python3.. / manage.py createsuperuser\-email admin@example.com\-username admin

Create a password when prompted.

Implement serialization and view in Django

In order for Django to pass the information to the HTTP GET request, the information object must be converted into valid response data. Django implements the "serialization class" serializers for this purpose.

In your project, create a new module called quickstart/serializers.py and use it to define some serializers that will be used for data presentation:

From django.contrib.auth.models import User, Groupfrom rest_framework import serializers class UserSerializer (serializers.HyperlinkedModelSerializer): class Meta: model = User fields = ['url',' username', 'email',' groups'] class GroupSerializer (serializers.HyperlinkedModelSerializer): class Meta: model = Group fields = ['url',' name']

The view in Django is a function that accepts a Web request and returns a Web response. The response can be HTML, HTTP redirection, HTTP error, JSON or XML document, image or TAR file, or anything else obtained from Internet. To create a view, open quickstart/views.py and enter the following code. The file already exists and contains some sample text, keep the text and add the following code to the file:

From django.contrib.auth.models import User, Groupfrom rest_framework import viewsetsfrom tutorial.quickstart.serializers import UserSerializer GroupSerializer class UserViewSet (viewsets.ModelViewSet): "" API allows you to view or edit users "" queryset = User.objects.all () .order_by ('- date_joined') serializer_class = UserSerializer class GroupViewSet (viewsets.ModelViewSet): "API allows you to view or edit groups"queryset = Group.objects.all () serializer_class = GroupSerializer generates URL using Django

Now, you can generate URL so that people can access your fledgling API. Open urls.py in a text editor and replace the default sample code with the following code:

From django.urls import include, pathfrom rest_framework import routersfrom tutorial.quickstart import views router = routers.DefaultRouter () router.register (rushing userslists, views.UserViewSet) router.register (rushing groupsshipping, views.GroupViewSet) # use automatic routing URL# and log in to URLurlpatterns = [path ('', include (router.urls)), path ('api-auth/', include (' rest_framework.urls', namespace='rest_framework')] to adjust your Django project settings

The setup module for this sample project is stored in tutorial/settings.py, so open it in a text editor and add rest_framework at the end of the INSTALLED_APPS list:

INSTALLED_APPS = [... 'rest_framework',] Test Django API

Now you can test the built API. First, start the built-in server from the command line:

$python3 manage.py runserver

You can access API by navigating to URL http://localhost:8000/users using curl:

$curl-- get http://localhost:8000/users/?format=json[{"url":"http://localhost:8000/users/1/?format=json","username":"admin","email":"admin@example.com","groups":[]}]

Use Firefox or the open source browser of your choice:

A simple Django API

For more in-depth knowledge of RESTful API using Django and Python, refer to the excellent Django documentation.

Why use Djago?

The main advantages of Django are:

The size of the Django community is growing, so even if you work on a complex project, there will be a lot of mentoring resources.

The default includes functions such as templates, routing, forms, authentication and management tools, so you don't have to look for external tools or worry about compatibility issues introduced by third-party tools.

The simple structure of users, loops, and conditions allows you to focus on writing code.

This is a mature and optimized framework that is very fast and reliable.

The main disadvantages of Django are:

Django is complicated! From a developer's perspective, it may be more difficult to learn than a simple framework.

Django has a large ecosystem. Once you are familiar with it, it will be great, but when you study deeply, it can be confusing.

Thank you for reading! This is the end of the article on "how to write a Python Web API with the help of Django". I hope the above content can be of some help to you, so that you can learn more knowledge. if you think the article is good, you can share it for more people to see!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.