python (Django) (一)普通接口

1. settings.py 含 mysql配置, logging配置

"""
Django settings for students project.

Generated by 'django-admin startproject' using Django 2.1.

For more information on this file, see
https://docs.djangoproject.com/en/2.1/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.1/ref/settings/
"""

import os

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.1/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '!1$28=no#5ysal8$0#2c(1le^$p#v^%ru3y=ah^8qar2ph^vu_'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []



# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'api.apps.ApiConfig',
    'rest_framework',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

ROOT_URLCONF = 'students.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')]
        ,
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

WSGI_APPLICATION = 'students.wsgi.application'


# Database
# https://docs.djangoproject.com/en/2.1/ref/settings/#databases

# MYSQL CONFIG
MYSQL_CONFIG = {
    'ENGINE': 'django.db.backends.mysql',
    'HOST': '192.168.80.133',
    'PORT': '3309',
    'NAME': 'students',
    'USER': 'root',
    'PASSWD': '123456'
}

# Django中mysql信息设置
DATABASES = {
    # 'default': {
    #     # 'ENGINE': 'django.db.backends.sqlite3',
    #     # 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    # }
    'default': {
        'ENGINE': MYSQL_CONFIG.get('ENGINE'),
        'HOST': MYSQL_CONFIG.get('HOST'),
        'PORT': MYSQL_CONFIG.get('PORT'),
        'NAME': MYSQL_CONFIG.get('NAME'),
        'USER': MYSQL_CONFIG.get('USER'),
        'PASSWORD': MYSQL_CONFIG.get('PASSWD'),
    }
}

# Password validation
# https://docs.djangoproject.com/en/2.1/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]


# Internationalization
# https://docs.djangoproject.com/en/2.1/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'Asia/Shanghai'

USE_I18N = True

USE_L10N = True

USE_TZ = False


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.1/howto/static-files/

STATIC_URL = '/static/'

# ================ Django logging begin =========================
import logging

LOGGING_DIR = BASE_DIR + os.sep + 'logs'
if not os.path.isdir(LOGGING_DIR):
    os.makedirs(LOGGING_DIR)


LOG_LEVEL = 'DEBUG' if DEBUG else 'INFO'

LOGGING = {
    'version': 1,
    'disable_existing_loggers': True,
    'formatters': {
        'standard': {
            'format': '[%(levelname)s]-[%(asctime)s]-[%(filename)s]-[%(funcName)s]-[%(lineno)d] >> %(message)s',
        },
        'simple': {
            'format': '[%(funcName)s]-[%(lineno)d] >> %(message)s',
        },
    },
    'filters': {
        'require_debug_true': {
            '()': 'django.utils.log.RequireDebugTrue',
        },
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'filters': ['require_debug_true'],
            'class': 'logging.StreamHandler',
            'formatter': 'simple',
        },
        'file_handler': {
            'encoding': 'utf8',
            'level': 'INFO',
            'class': 'logging.handlers.TimedRotatingFileHandler',
            'when': 'M',
            'interval': 1,
            'backupCount': 180,
            'filename': '%s/students.log' % LOGGING_DIR,
            'formatter': 'standard',
        },
    },
    'loggers': {
        'api': {
            'handlers': ['console', 'file_handler'],
            'level': 'DEBUG',
            'propagate': True,
        },
    }
}

# 具体模块中使用
# def get_logger(name=None):
#     return logging.getLogger(name)

# ================ Django logging end ==========================

2. api/models.py 模型

from django.db import models

# Create your models here.
# ALTER TABLE student MODIFY COLUMN create_time DATETIME DEFAULT CURRENT_TIMESTAMP;
# ALTER TABLE student MODIFY COLUMN update_time DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP;


class Student(models.Model):

    GRADE = (
        (1, 'grade 1'),
         (2, 'grade 2'),
         (3, 'grade 3'),
    )

    grade = models.IntegerField(choices=GRADE, default=1)
    name = models.CharField(max_length=32, unique=True)
    password = models.CharField(max_length=32)

    create_time = models.DateTimeField(auto_now_add=True)
    update_time = models.DateTimeField(auto_now=True)

    class Meta:
        db_table = 'student'
        ordering = ('create_time',)
        verbose_name = 'students info'


class Token(models.Model):
    student = models.OneToOneField(to=Student, on_delete=models.CASCADE)
    token = models.CharField(max_length=32)
    create_time = models.DateTimeField(auto_now_add=True)
    update_time = models.DateTimeField(auto_now=True)

    class Meta:
        db_table = 'token'

3. api/views.py

from django.shortcuts import render
from .utils import get_logger

logger = get_logger(name='api')


from django.shortcuts import HttpResponse
from django.http import JsonResponse
from rest_framework.response import Response
from rest_framework.exceptions import NotFound, ParseError
from django.utils.translation import ugettext as _

from django.views import View
from rest_framework.views import APIView
from rest_framework.viewsets import GenericViewSet
from rest_framework import status

from rest_framework.parsers import JSONParser
import json
from pprint import pprint, pformat

import time
from hashlib import md5

from .models import Student, Token


def get_md5_encode(user, password):
    bytes_str = bytes(user, encoding='utf-8') + ':'.encode('utf-8') + bytes(password, encoding='utf-8') + bytes(str(time.time()), encoding='utf-8')
    m = md5(bytes_str)
    return m.hexdigest()


class AuthView(APIView):
    authentication_classes = []
    permission_classes = []
    parser_classes = [JSONParser,]

    def get(self, request, *args, **kwargs):
        name = request.query_params.get('name')
        try:
            stu = Student.objects.get(name=name)
        except Student.DoesNotExist:
            raise ParseError(_('Student does not include this name'))

        token = stu.token.token
        res = dict()
        res['code'] = 200
        res['name'] = name
        res['token'] = token
        logger.info(pformat(res))

        return Response(data=res, status=status.HTTP_200_OK)

    def post(self, request, *args, **kwargs):
        name = request.data.get('name')
        password = request.data.get('password')

        if not (name or password):
            raise ParseError(_('name or password should not be empty'))

        student, ok = Student.objects.update_or_create(name=name, defaults={'grade': grade, 'password': password})
        # student = Student.objects.create(name=name, password=password)
        token, ok = Token.objects.update_or_create(student=student, defaults={'token': get_md5_encode(name, password)})
        res = dict()
        res['code'] = 200
        res['name'] = name
        res['token'] = token.token
        res['msg'] = '创建成功'
        logger.info(pformat(res))
        return Response(data=res, status=status.HTTP_200_OK)

4. urls.py

from django.contrib import admin
from django.urls import path
from django.conf.urls import url, include

urlpatterns = [
    path('admin/', admin.site.urls),
    url(r'^api/v1/', include('api.urls')),
]

5. api/urls.py

# -*- coding: utf8 -*-
from django.conf.urls import url
from .views import AuthView

urlpatterns = [
    url(r'auth/', AuthView.as_view()),
]

6. api/utils.py日志

# -*- coding: utf8 -*-

import logging


def get_logger(name=None):
    return logging.getLogger(name=name)

7. 代码结构

E:.
│  manage.py
│
├─.idea
│      encodings.xml
│      misc.xml
│      modules.xml
│      students.iml
│      workspace.xml
│
├─api
│  │  admin.py
│  │  apps.py
│  │  models.py
│  │  tests.py
│  │  urls.py
│  │  utils.py
│  │  views.py
│  │  __init__.py
 

├─logs
│      students.log
│      students.log.2019-12-22_17-03
│      students.log.2019-12-22_18-12
│
├─students
│  │  settings.py
│  │  urls.py
│  │  wsgi.py
│  │  __init__.py
 

8. postman:

url: http://127.0.0.1:8011/api/v1/auth/

method: post

type: json

data: {
    "name": "student1",
    "password": "password1"
}

返回: 

{
    "code": 200,
    "name": "student1",
    "token": "c13cea0a40a3fb8b60b8cbbacfa89e13",
    "msg": "创建成功"
}