RESTful API设计

• API与用户的通信协议，总是使用HTTPs协议。
• 域名 
  • https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
  • https://example.org/api/                        API很简单
• 版本
  • URL，如：https://api.example.com/v1/
  • 请求头                                                  跨域时，引发发送多次请求
• 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
  • https://api.example.com/v1/zoos
  • https://api.example.com/v1/animals
  • https://api.example.com/v1/employees
• method
  • GET      ：从服务器取出资源（一项或多项）
  • POST    ：在服务器新建一个资源
  • PUT      ：在服务器更新资源（客户端提供改变后的完整资源）
  • PATCH  ：在服务器更新资源（客户端提供改变的属性）
  • DELETE ：从服务器删除资源
• 过滤，通过在url上传参的形式传递搜索条件
  • https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
  • https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
  • https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
  • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
  • https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

#  当我们来介绍rest 规范时候可以从url的顺序来介绍

#     http://api.luffycity.com/v1/users

#    1 http ：协议

#    2 api.luffycity.com ：域名

#    3 v1：版本

#    4 users：urls中是名词

5：发送过去有不同的请求方式

    即：method不同执行不同函数：get/post/delete/put/patch

6：返回状态码

    常见状态码：200/301/302/404/403/500

7：错误信息：

    {

        msg: '用户名或密码错误'

    }

        def index(request):

        ret = {'code':1000,'data':None}

            return HttpResponse('xxx',status=200)

8：返回值：

    http://api.luffycity.com/v1/users

    http://api.luffycity.com/v1/users/1

9：条件

http://api.luffycity.com/v1/users?page=1&size=10

PS: 主键ID体现在URL上

10 hyperlink

{

    id: '老司机',

    age: 18,

    group: http://www.luffycti.com/api/v1/group/1/

}     

按请求进来的顺序

1：路由

    请求进来要走路由

2：视图

    路由写完就到了视图

3：版本

请求进去源码dispatch里面有4个方法

4：认证

5：权限

6：节流（频率）

7：解析器

发数据需要转换数据类型

8：序列化

    需要校验数据（序列化有2个功能：序列化，校验）

9：分页

10：渲染器

加括号的三种情况

类

函数或者加方法执行

对象

# 文件启动会先运行init文件

import settings

import importlib

def send_xxxx(content):

    for path in settings.NOTIFY_LIST:

        # 'notify.email.Email',

        # 'notify.msg.Msg',

        # 'notify.wechat.Wechat'

        # module_path模块路径

        module_path,class_name = path.rsplit('.',maxsplit=1)

        # importlib.import_module("notify.email")

        # 根据字符串导入模块：notify.email

        # importlib

        module = importlib.import_module(module_path)

        # 根据类名称去模块中获取类

        cls = getattr(module,class_name)

        # 根据类实例化

        obj = cls()

        obj.send(content)

init。py

class Email(object):

    def __init__(self):

        pass

    def send(self):

        pass

email.py

from notify import send_xxxx

def run():

    send_xxxx('报警')

if __name__ == '__main__':

    pass

app

NOTIFY_LIST = [

    'notify.email.Email',

    # 'notify.msg.Msg',

    'notify.wechat.Wechat',

    'notify.wechat.Wechat',

]

settings