Web API接口规范与测试方法

{
    "status":0,
    "message":"ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
        ...
        ]
}

'''
0:成功
1:失败     1xx：具体失败信息(要在接口文档中明确写出)
2:无数据   2xx：具体无数据信息(要在接口文档中明确写出)
'''

{
    "status": 0,
    "msg": "ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
        ...
        ]
}

{
    "status": 0,
    "msg": "ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
        ...
        ]
}

from . import views
from django.conf.urls import url

urlpatterns = [

    url(r'^books/$',views.BookView.as_view()),
    url(r'^books/(?P<pk>\d+)/$',views.BookView.as_view()),

]

    @classonlymethod
    def as_view(cls, **initkwargs):#类方法，所以可以类名.方法名()调用
        """
        Main entry point for a request-response process.
        """
       # 项目刚启动时initkwargs为空，不走下面的循环
        for key in initkwargs:
            if key in cls.http_method_names:
                raise TypeError("You tried to pass in the %s method name as a "
                                "keyword argument to %s(). Don't do that."
                                % (key, cls.__name__))
            if not hasattr(cls, key):
                raise TypeError("%s() received an invalid keyword %r. as_view "
                                "only accepts arguments that are already "
                                "attributes of the class." % (cls.__name__, key))
        
        # 请求来了完成响应的函数
        #wsgi协议将浏览器发过来的数据拆分后放入request
        def view(request, *args, **kwargs):
            self = cls(**initkwargs)
            #类实例化的对象
            
            #利用反射添加get请求，get和head一样
            if hasattr(self, 'get') and not hasattr(self, 'head'):
                self.head = self.get
            # 为对象添加属性
            self.request = request
            self.args = args #无名分组参数
            self.kwargs = kwargs # 有名分组的参数 
            
            #将执行结果返回到前台
            return self.dispatch(request, *args, **kwargs)
        #下面两句的作用：将请求调用view的信息保存在view对象中
        view.view_class = cls
        #将类名添加到view的名称空间
        view.view_initkwargs = initkwargs
        #将as_view携带的参数添加到名称空间
        
        # take name and docstring from class
        update_wrapper(view, cls, updated=())

        # and possible attributes set by decorators
        # like csrf_exempt from dispatch
        update_wrapper(view, cls.dispatch, assigned=())
        
        #返回请求调用的函数地址，进行路由绑定
        return view

    def dispatch(self, request, *args, **kwargs):
        # Try to dispatch to the right method; if a method doesn't exist,
        # defer to the error handler. Also defer to the error handler if the
        # request method isn't on the approved list.
        if request.method.lower() in self.http_method_names:
            handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
        else:
            handler = self.http_method_not_allowed
        return handler(request, *args, **kwargs)

    def dispatch(self, request, *args, **kwargs):
        # Try to dispatch to the right method; if a method doesn't exist,
        # defer to the error handler. Also defer to the error handler if the
        # request method isn't on the approved list.
        #通过反射的方式判断请求的方法是否存在，如果存在就加()调用，不存在就报错
        if request.method.lower() in self.http_method_names:
            handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
        else:
            handler = self.http_method_not_allowed
        return handler(request, *args, **kwargs)