{"id":187,"date":"2026-06-28T10:32:34","date_gmt":"2026-06-28T02:32:34","guid":{"rendered":"https:\/\/yykcj.com\/?p=187"},"modified":"2026-06-28T10:32:34","modified_gmt":"2026-06-28T02:32:34","slug":"django-ninja-api-%e5%ae%9e%e6%88%98%ef%bc%9a%e6%9e%84%e5%bb%ba%e9%ab%98%e6%80%a7%e8%83%bdrestful%e6%9c%8d%e5%8a%a1%e7%9a%84%e6%9c%80%e4%bd%b3%e5%ae%9e%e8%b7%b5","status":"publish","type":"post","link":"https:\/\/yykcj.com\/?p=187","title":{"rendered":"Django + Ninja API \u5b9e\u6218\uff1a\u6784\u5efa\u9ad8\u6027\u80fdRESTful\u670d\u52a1\u7684\u6700\u4f73\u5b9e\u8df5"},"content":{"rendered":"<h2>\u4e3a\u4ec0\u4e48\u9009\u62e9Django Ninja\uff1f<\/h2>\n<p>Django Ninja \u662f\u4e00\u4e2a\u57fa\u4e8e Python \u7c7b\u578b\u63d0\u793a\u7684 Django REST \u6846\u67b6\uff0c\u5b83\u7ed3\u5408\u4e86 Django \u7684\u6210\u719f\u751f\u6001\u548c FastAPI \u7684\u7b80\u6d01\u9ad8\u6548\u3002\u76f8\u6bd4\u4e8e Django REST Framework (DRF)\uff0cNinja \u5177\u6709\u4ee5\u4e0b\u4f18\u52bf\uff1a<\/p>\n<ul>\n<li><strong>\u81ea\u52a8\u751f\u6210 OpenAPI \u6587\u6863<\/strong>\uff1a\u65e0\u9700\u989d\u5916\u914d\u7f6e\uff0c\u5373\u5f97 Swagger UI \u548c ReDoc\u3002<\/li>\n<li><strong>\u7c7b\u578b\u5b89\u5168<\/strong>\uff1a\u5229\u7528 Pydantic \u8fdb\u884c\u53c2\u6570\u6821\u9a8c\uff0c\u51cf\u5c11\u8fd0\u884c\u65f6\u9519\u8bef\u3002<\/li>\n<li><strong>\u9ad8\u6027\u80fd<\/strong>\uff1a\u57fa\u4e8e\u5f02\u6b65\u89c6\u56fe\uff0c\u652f\u6301\u9ad8\u5e76\u53d1\u573a\u666f\u3002<\/li>\n<li><strong>\u8f7b\u91cf\u7ea7<\/strong>\uff1aAPI \u4ee3\u7801\u66f4\u7b80\u6d01\uff0c\u5b66\u4e60\u6210\u672c\u4f4e\u3002<\/li>\n<\/ul>\n<p>\u672c\u6587\u5c06\u5e26\u4f60\u4ece\u96f6\u642d\u5efa\u4e00\u4e2a\u56fe\u4e66\u7ba1\u7406 API \u7cfb\u7edf\uff0c\u6db5\u76d6\u5e38\u89c1\u4e1a\u52a1\u573a\u666f\u3002<\/p>\n<h2>\u73af\u5883\u51c6\u5907<\/h2>\n<p>\u786e\u4fdd\u5df2\u5b89\u88c5 Python 3.8+\uff0c\u7136\u540e\u521b\u5efa\u865a\u62df\u73af\u5883\u5e76\u5b89\u88c5\u4f9d\u8d56\uff1a<\/p>\n<pre><code class=\"language-bash\">\npip install django ninja\n<\/code><\/pre>\n<h2>\u7b2c\u4e00\u6b65\uff1a\u521b\u5efa Django \u9879\u76ee<\/h2>\n<pre><code class=\"language-bash\">\ndjango-admin startproject bookmanager\ncd bookmanager\npython manage.py startapp books\n<\/code><\/pre>\n<p>\u5c06 <code>books<\/code> \u6dfb\u52a0\u5230 <code>INSTALLED_APPS<\/code>\uff1a<\/p>\n<pre><code class=\"language-python\">\n# bookmanager\/settings.py\nINSTALLED_APPS = [\n    ...\n    &#x27;books&#x27;,\n]\n<\/code><\/pre>\n<h2>\u7b2c\u4e8c\u6b65\uff1a\u5b9a\u4e49\u6a21\u578b<\/h2>\n<pre><code class=\"language-python\">\n# books\/models.py\nfrom django.db import models\n\nclass Book(models.Model):\n    title = models.CharField(max_length=200)\n    author = models.CharField(max_length=100)\n    published_date = models.DateField()\n    isbn = models.CharField(max_length=13, unique=True)\n    price = models.DecimalField(max_digits=6, decimal_places=2)\n\n    def __str__(self):\n        return self.title\n<\/code><\/pre>\n<p>\u6267\u884c\u8fc1\u79fb\uff1a<\/p>\n<pre><code class=\"language-bash\">\npython manage.py makemigrations\npython manage.py migrate\n<\/code><\/pre>\n<h2>\u7b2c\u4e09\u6b65\uff1a\u521b\u5efa Ninja API<\/h2>\n<p>\u5728 <code>books<\/code> \u76ee\u5f55\u4e0b\u521b\u5efa <code>api.py<\/code>\uff1a<\/p>\n<pre><code class=\"language-python\">\n# books\/api.py\nfrom ninja import NinjaAPI, ModelSchema, Schema\nfrom typing import List\nfrom .models import Book\nfrom django.shortcuts import get_object_or_404\n\napi = NinjaAPI()\n\n# \u5b9a\u4e49\u8f93\u5165\u8f93\u51fa Schema\nclass BookIn(Schema):\n    title: str\n    author: str\n    published_date: str  # \u63a5\u6536\u5b57\u7b26\u4e32\uff0c\u540e\u7eed\u8f6c\u6362\n    isbn: str\n    price: float\n\nclass BookOut(ModelSchema):\n    class Meta:\n        model = Book\n        fields = [&#x27;id&#x27;, &#x27;title&#x27;, &#x27;author&#x27;, &#x27;published_date&#x27;, &#x27;isbn&#x27;, &#x27;price&#x27;]\n\n# \u8f6c\u6362\u65e5\u671f\u5b57\u7b26\u4e32\nfrom datetime import datetime\n\n@api.post(&quot;\/books\/&quot;, response=BookOut)\ndef create_book(request, payload: BookIn):\n    # \u5c06\u5b57\u7b26\u4e32\u65e5\u671f\u8f6c\u6362\u4e3a date \u5bf9\u8c61\n    try:\n        published_date = datetime.strptime(payload.published_date, &quot;%Y-%m-%d&quot;).date()\n    except ValueError:\n        return api.create_response(request, {&quot;error&quot;: &quot;\u65e5\u671f\u683c\u5f0f\u9519\u8bef\uff0c\u5e94\u4e3a YYYY-MM-DD&quot;}, status=400)\n    book = Book.objects.create(\n        title=payload.title,\n        author=payload.author,\n        published_date=published_date,\n        isbn=payload.isbn,\n        price=payload.price\n    )\n    return book\n\n@api.get(&quot;\/books\/&quot;, response=List[BookOut])\ndef list_books(request):\n    return Book.objects.all()\n\n@api.get(&quot;\/books\/{book_id}&quot;, response=BookOut)\ndef get_book(request, book_id: int):\n    book = get_object_or_404(Book, id=book_id)\n    return book\n\n@api.put(&quot;\/books\/{book_id}&quot;, response=BookOut)\ndef update_book(request, book_id: int, payload: BookIn):\n    book = get_object_or_404(Book, id=book_id)\n    try:\n        published_date = datetime.strptime(payload.published_date, &quot;%Y-%m-%d&quot;).date()\n    except ValueError:\n        return api.create_response(request, {&quot;error&quot;: &quot;\u65e5\u671f\u683c\u5f0f\u9519\u8bef&quot;}, status=400)\n    book.title = payload.title\n    book.author = payload.author\n    book.published_date = published_date\n    book.isbn = payload.isbn\n    book.price = payload.price\n    book.save()\n    return book\n\n@api.delete(&quot;\/books\/{book_id}&quot;, response={204: None})\ndef delete_book(request, book_id: int):\n    book = get_object_or_404(Book, id=book_id)\n    book.delete()\n    return 204, None\n<\/code><\/pre>\n<h2>\u7b2c\u56db\u6b65\uff1a\u6ce8\u518c API \u8def\u7531<\/h2>\n<p>\u5728 <code>bookmanager\/urls.py<\/code> \u4e2d\uff1a<\/p>\n<pre><code class=\"language-python\">\nfrom django.contrib import admin\nfrom django.urls import path\nfrom books.api import api\n\nurlpatterns = [\n    path(&#x27;admin\/&#x27;, admin.site.urls),\n    path(&#x27;api\/&#x27;, api.urls),\n]\n<\/code><\/pre>\n<h2>\u7b2c\u4e94\u6b65\uff1a\u8fd0\u884c\u5e76\u6d4b\u8bd5<\/h2>\n<pre><code class=\"language-bash\">\npython manage.py runserver\n<\/code><\/pre>\n<p>\u8bbf\u95ee <code>http:\/\/127.0.0.1:8000\/api\/docs<\/code> \u5373\u53ef\u770b\u5230 Swagger \u6587\u6863\u3002<\/p>\n<h3>\u6d4b\u8bd5 API<\/h3>\n<p>\u4f7f\u7528 curl \u6216 Postman \u6d4b\u8bd5\uff1a<\/p>\n<pre><code class=\"language-bash\">\n# \u521b\u5efa\u56fe\u4e66\ncurl -X POST http:\/\/127.0.0.1:8000\/api\/books\/ \\\n  -H &quot;Content-Type: application\/json&quot; \\\n  -d &#x27;{&quot;title&quot;:&quot;Django Ninja\u5b9e\u6218&quot;,&quot;author&quot;:&quot;\u5f20\u4e09&quot;,&quot;published_date&quot;:&quot;2024-01-15&quot;,&quot;isbn&quot;:&quot;9781234567890&quot;,&quot;price&quot;:39.99}&#x27;\n\n# \u83b7\u53d6\u5217\u8868\ncurl http:\/\/127.0.0.1:8000\/api\/books\/\n<\/code><\/pre>\n<h2>\u8fdb\u9636\u6280\u5de7\uff1aORM \u4f18\u5316\u4e0e\u5206\u9875<\/h2>\n<p>\u5f53\u6570\u636e\u91cf\u5927\u65f6\uff0c\u76f4\u63a5\u8fd4\u56de <code>Book.objects.all()<\/code> \u53ef\u80fd\u5bfc\u81f4\u6027\u80fd\u95ee\u9898\u3002Ninja \u5185\u7f6e\u4e86\u5206\u9875\u652f\u6301\uff1a<\/p>\n<pre><code class=\"language-python\">\nfrom ninja.pagination import paginate, PageNumberPagination\n\n@api.get(&quot;\/books\/&quot;, response=List[BookOut])\n@paginate(PageNumberPagination, page_size=10)\ndef list_books(request):\n    return Book.objects.all().select_related()  # \u4f18\u5316\u5173\u8054\u67e5\u8be2\n<\/code><\/pre>\n<p>\u540c\u65f6\uff0c\u5728\u67e5\u8be2\u4e2d\u4f7f\u7528 <code>select<em>related<\/code> \u6216 <code>prefetch<\/em>related<\/code> \u51cf\u5c11\u6570\u636e\u5e93\u67e5\u8be2\u6b21\u6570\u3002<\/p>\n<h2>\u9519\u8bef\u5904\u7406\u6700\u4f73\u5b9e\u8df5<\/h2>\n<p>\u4f7f\u7528 Ninja \u7684\u5f02\u5e38\u5904\u7406\u673a\u5236\u7edf\u4e00\u8fd4\u56de\u683c\u5f0f\uff1a<\/p>\n<pre><code class=\"language-python\">\nfrom ninja.errors import HttpError\n\n@api.exception_handler(HttpError)\ndef custom_http_error_handler(request, exc):\n    return api.create_response(\n        request,\n        {&quot;detail&quot;: exc.message},\n        status=exc.status_code,\n    )\n<\/code><\/pre>\n<h2>\u603b\u7ed3<\/h2>\n<p>\u672c\u6587\u4ecb\u7ecd\u4e86\u5982\u4f55\u4f7f\u7528 Django Ninja \u5feb\u901f\u6784\u5efa\u4e00\u4e2a\u56fe\u4e66\u7ba1\u7406 API\uff0c\u6db5\u76d6\u6a21\u578b\u5b9a\u4e49\u3001Schema \u8bbe\u8ba1\u3001CRUD \u64cd\u4f5c\u3001\u81ea\u52a8\u6587\u6863\u751f\u6210\u4ee5\u53ca\u6027\u80fd\u4f18\u5316\u3002\u76f8\u6bd4\u4e8e DRF\uff0cNinja \u7684\u4ee3\u7801\u91cf\u66f4\u5c11\uff0c\u7c7b\u578b\u5b89\u5168\u66f4\u5f3a\uff0c\u975e\u5e38\u9002\u5408\u73b0\u4ee3 API \u5f00\u53d1\u3002<\/p>\n<h3>\u4e0b\u4e00\u6b65\u65b9\u5411<\/h3>\n<ul>\n<li>\u96c6\u6210\u8ba4\u8bc1\uff08JWT \u6216 Session\uff09<\/li>\n<li>\u6dfb\u52a0\u5355\u5143\u6d4b\u8bd5<\/li>\n<li>\u4f7f\u7528\u5f02\u6b65\u89c6\u56fe\u5904\u7406 I\/O \u5bc6\u96c6\u578b\u4efb\u52a1<\/li>\n<\/ul>\n<p>\u6b22\u8fce\u5728\u8bc4\u8bba\u533a\u4ea4\u6d41\u4f60\u7684\u5b9e\u6218\u7ecf\u9a8c\uff01<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u672c\u6587\u624b\u628a\u624b\u6559\u4f60\u4f7f\u7528Django Ninja\u6784\u5efaRESTful API\uff0c\u6db5\u76d6\u9879\u76ee\u642d\u5efa\u3001\u8def\u7531\u8bbe\u8ba1\u3001\u53c2\u6570\u6821\u9a8c\u3001ORM\u4f18\u5316\u53ca\u81ea\u52a8\u6587\u6863\u751f\u6210\uff0c\u52a9\u4f60\u5feb\u901f\u6253\u9020\u9ad8\u6548\u3001\u53ef\u7ef4\u62a4\u7684API\u670d\u52a1\u3002<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3,4],"tags":[84,85,86,42,66],"class_list":["post-187","post","type-post","status-publish","format-standard","hentry","category-3","category-4","tag-django","tag-ninja-api","tag-python","tag-restful","tag-66"],"_links":{"self":[{"href":"https:\/\/yykcj.com\/index.php?rest_route=\/wp\/v2\/posts\/187","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/yykcj.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/yykcj.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/yykcj.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/yykcj.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=187"}],"version-history":[{"count":0,"href":"https:\/\/yykcj.com\/index.php?rest_route=\/wp\/v2\/posts\/187\/revisions"}],"wp:attachment":[{"href":"https:\/\/yykcj.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=187"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/yykcj.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=187"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/yykcj.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=187"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}