当前位置: 首页 > article >正文

Django自动生成docs接口文档

1.创建Django项目

python manage.py startproject django2025

2.创建子应用

python manage.py startapp api

3.安装依赖包

pip install coreapi

4.创建urls.py

from django.contrib import admin
from django.urls import path, include
from rest_framework import routers
from api.views import MyAPIView
from rest_framework.schemas import get_schema_view
from rest_framework.documentation import include_docs_urls
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
schema_view = get_schema_view(
    openapi.Info(
        title="API Documentation",
        default_version='v1',
    ),
    public=False
)
urlpatterns = [
    path('admin/', admin.site.urls),
    path(r'docs/', include_docs_urls(title='API文档')),
    path('api/hello/', MyAPIView.as_view()),
]

5.编写view.py视图

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.schemas import AutoSchema


class MyAPIView(APIView):
    """
    A simple API View with GET and POST methods.
    """
    schema = AutoSchema()  # 自动创建API文档的Schema

    def get(self, request, *args, **kwargs):
        response = {'message': 'Hello, World!'}
        return Response(response)

    def post(self, request, *args, **kwargs):
        response = {'message': 'Got some data!', 'data': request.data}
        return Response(response)


6.访问页面检查

http://127.0.0.1:8000/docs/

在这里插入图片描述


http://www.kler.cn/news/135224.html

相关文章:

  • plantuml最原始的主题如何设置
  • 进阶JAVA篇- Java 综合基本语法实践(习题一)
  • 变量命名的规则与规范
  • DC综合基本概念:set_compile_directives
  • Java中锁的深入理解
  • CentOS Stream 9-使用 systemd 管理自己程序时自定义日志路径
  • Python大数据之linux学习总结——day11_ZooKeeper
  • Dubbo快速实践
  • Unity在Windows选项下没有Auto Streaming
  • virtuoso 后仿 ADE L error
  • Cannot find proj.db
  • 二十三种设计模式全面解析-职责链模式(Chain of Responsibility Pattern):解放代码责任链,提升灵活性与可维护性
  • 哪些软件可以监控电脑(保姆级教程!值得收藏!)
  • Vue3+Vite实现工程化,插值表达式和v-text以及v-html
  • java switch case 多条件 正确案例错误案例
  • 【ArcGIS Pro二次开发】:CC工具箱1.1.1更新_免费_安装即可用
  • 如何防止研发把代码上传到私人gitee/github?
  • 猫罐头哪个牌子质量好性价比高?推荐十款猫罐头品牌排行榜!
  • 用GPT 搭建一个占星术、解梦、塔罗牌占卜和命理学服务
  • 论文阅读:“基于特征检测与深度特征描述的点云粗对齐算法”
  • ModernCSS.dev - 来自微软前端工程师的 CSS 高级教程,讲解如何用新的 CSS 语法来解决旧的问题
  • memcacheredis构建缓存服务器
  • 矿区安全检查VR模拟仿真培训系统更全面、生动有效
  • Linux内核调试篇——获取内核函数地址的四种方法(一文解决)
  • 对象和数据结构
  • Backtrader绘图cerebro.plot报错问题的处理
  • 美国DDoS服务器:如何保护你的网站免遭攻击?
  • 优化资源利用率:kubernetes中装箱的好处与挑战
  • Scala---WordCount
  • 著名的勃艮第葡萄酒是如何分类的?