标签：error products error: nal rfc views article 清单 sql
应该尽量将API部署在专用域名之下。
https://api.example.com
如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。
https://example.org/api/
应该将API的版本号放入URL。
http://www.example.com/app/1.0/foo http://www.example.com/app/1.1/foo http://www.example.com/app/2.0/foo
另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。
因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见Versioning REST Services）：
Accept: vnd.example-com.foo+json; version=1.0 Accept: vnd.example-com.foo+json; version=1.1 Accept: vnd.example-com.foo+json; version=2.0
路径又称"终点"（endpoint），表示API的具体网址，每个网址代表一种资源（resource）
(1) 资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应。
举例来说，以下是不好的例子:
/getProducts /listOrders /retreiveClientByOrder?orderId=1
对于一个简洁结构，你应该始终用名词。 此外，利用的HTTP方法可以分离网址中的资源名称的操作。
GET /products ：将返回所有产品清单 POST /products ：将产品新建到集合 GET /products/4 ：将获取产品 4 PATCH（或）PUT /products/4 ：将更新产品 4
(2) API中的名词应该使用复数。无论子资源或者所有资源。
举例来说，获取产品的API可以这样定义
获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products
对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面四个（括号里是对应的SQL命令）。
还有三个不常用的HTTP动词。
下面是一些例子。
GET /zoos：列出所有动物园 POST /zoos：新建一个动物园（上传文件） GET /zoos/ID：获取某个指定动物园的信息 PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息） PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息） DELETE /zoos/ID：删除某个动物园 GET /zoos/ID/animals：列出某个指定动物园的所有动物 DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
下面是一些常见的参数。
?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的开始位置。 ?page=2&per_page=100：指定第几页，以及每页的记录数。 ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。 ?animal_type_id=1：指定筛选条件
参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。
- 200 OK - [GET]：服务器成功返回用户请求的数据
- 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
- 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
- 204 NO CONTENT - [DELETE]：用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作
- 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
- 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
- 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
- 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
- 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
状态码的完全列表参见
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
如果状态码是4xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
{ error: "Invalid API key" }
针对不同操作，服务器向用户返回的结果应该符合以下规范。
RESTful API最好做到Hypermedia（即返回结果中提供链接，连向其他API方法），使得用户不查文档，也知道下一步应该做什么。
比如，Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。
{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations", // ... }
从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。
{ "message": "Requires authentication", "documentation_url": "https://developer.github.com/v3" }
上面代码表示，服务器给出了提示信息，以及文档的网址。
服务器返回的数据格式，应该尽量使用JSON，避免使用XML。
urlpatterns = { url(r‘^index/$‘, views.index), url(r‘^books/$‘, views.BooksAPIView.as_view()), url(r‘^books/(?P<pk>\d+)/$‘, views.BookAPIView.as_view()), url(r‘^heros/$‘, views.HerosAPIView.as_view()), url(r‘^heros/(?P<pk>\d+)/$‘, views.HeroAPIView.as_view()), }
import json from django.forms import model_to_dict from django.http import JsonResponse from django.shortcuts import HttpResponse from django.views import View from app001.models import BookInfo from app001.models import HeroInfo def index(request): return HttpResponse("ok") class BooksAPIView(View): def get(self, request): """ 查询所有图书 :param request: :return: """ queryset = BookInfo.objects.all().values() book_list = [] book_list = list(queryset) return JsonResponse(book_list, safe=False) def post(self, request): """ 新增图书 :param request: :return: """ json_bytes = request.body json_str = json_bytes.decode() book_dict = json.loads(json_str) # book = BookInfo.objects.create( # btitle = book_dict.get("btitle"), # bpub_date = datetime.strptime(book_dict.get("bpub_date"),‘%Y-%m-%d‘).date(), # ) book = BookInfo.objects.create( **book_dict ) return JsonResponse({ "id": book.id, "btitle": book.btitle, ‘bpub_date‘: book.bpub_date, ‘bread‘: book.bread, ‘bcomment‘: book.bcomment, # ‘image‘: book.image.url if book.image else ‘‘ }, status=201) class BookAPIView(View): """ 获取单个图书的信息 """ def get(self, request, pk): try: book = BookInfo.objects.get(id=pk) except Exception as e: print(e) return HttpResponse(status=404) book_dict = model_to_dict(book) return JsonResponse(book_dict) def put(self, request, pk): """ 修改图书信息 :param request: :param pk: :return: """ try: book = BookInfo.objects.get(id=pk) except Exception as e: print(e) return HttpResponse(status=404) # 校验参数 json_bytes = request.body json_str = json_bytes.decode() book_dict = json.loads(json_str) BookInfo.objects.filter(id=pk).update(**book_dict) # from django.forms.models import model_to_dict book_dict = model_to_dict(BookInfo.objects.get(id=pk)) return JsonResponse(book_dict) def delete(self, request, pk): """ 删除 :param request: :param pk: :return: """ try: book = BookInfo.objects.get(id=pk) except Exception as e: print(e) return HttpResponse(status=404) book.delete() return HttpResponse(status=204) class HerosAPIView(View): def get(self, request): hero = HeroInfo.objects.all().values() hero = list(hero) return JsonResponse(hero, safe=False) def post(self, request): json_bytes = request.body json_str = json_bytes.decode() hero_dict = json.loads(json_str) hero = "" try: hero = HeroInfo.objects.create(**hero_dict) except Exception as e: print(e) return HttpResponse(status=404) return JsonResponse(model_to_dict(hero), status=201) class HeroAPIView(View): def get(self, request, pk): hero = HeroInfo.objects.get(id=pk) return JsonResponse(model_to_dict(hero)) def put(self, request, pk): """ 修改图书 :param request: :param pk: :return: """ try: hero = HeroInfo.objects.get(id=pk) except Exception as e: print(e) return HttpResponse(status=404) json_bytes = request.body json_str = json_bytes.decode() json_dict = json.loads(json_str) hero = HeroInfo.objects.filter(id=pk).update(**json_dict) hero_dict = model_to_dict(HeroInfo.objects.get(id=pk)) return JsonResponse(hero_dict) def delete(self, request, pk): try: hero = HeroInfo.objects.get(id=pk) except Exception as e: print(e) return HttpResponse(status=404) hero.delete() return HttpResponse(status=204)
标签：error products error: nal rfc views article 清单 sql
原文地址：https://www.cnblogs.com/cerofang/p/9323067.html
