django 一开始没用 restfulapi 开发, 还能自动生成文档吗? - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
zzm88104
V2EX    Django

django 一开始没用 restfulapi 开发, 还能自动生成文档吗?

  •  
  •   zzm88104 2023-02-02 09:37:04 08:00 2764 次点击
    这是一个创建于 1050 天前的主题,其中的信息可能已经有所发展或是发生改变。
    一开始是想做个简单的小插件, 但后来功能越加越多.

    需要跟前端合作, 需要告知他新 api 的使用方式. 现在是丢给他保存了 example 的 postman 让他自己看. 这种方式对前端友好吗?

    文档肯定是最好, 但一条一条 api 写文档感觉比较低效, 只是用爱发电的小项目,也花不起太多时间.

    不知道有没有事后补救的办法?
    7 条回复    2023-03-08 04:31:40 +08:00
    yemoluo
        1
    yemoluo  
       2023-02-02 09:46:32 +08:00
    友好啊,没有比这个更直观了,前提是要告诉他们怎么用
    zombiecong
        2
    zombiecong  
       2023-02-02 09:50:05 +08:00
    django restful framework + [swagger]( https://django-rest-swagger.readthedocs.io/en/latest/)
    zzm88104
        3
    zzm88104  
    OP
       2023-02-02 10:07:22 +08:00
    @GTim #1 那就好, 那我应该可以不写文档了? 对方是个比我厉害多了的前端工程师
    zzm88104
        4
    zzm88104  
    OP
       2023-02-02 10:08:20 +08:00
    @zombiecong #2 好的, 原来这个也能事后补救啊! 那我研究下, 谢谢!
    yemoluo
        5
    yemoluo  
       2023-02-02 11:59:05 +08:00   1
    @zzm88104 配合默契度最重要的是接口格式和字段的统一性,比如第一次 user_id 表示用户编号,created_at 表示创建时间,title 表示标题, name 表示名称,反过来也一样,比如名称就是 name 或者 title 或者 subject , 那么厉害的前端对结一两次后就知道啥回事了
    zzm88104
        6
    zzm88104  
    OP
       2023-02-02 14:29:13 +08:00
    @GTim #5 明白了!谢谢 GTim
    zeusho871
        7
    zeusho871  
       2023-03-08 04:31:40 +08:00   1
    django-ninja-extra 导出 api doc ,可以在 apifox 里直接调试
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2721 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 25ms UTC 14:54 PVG 22:54 LAX 06:54 JFK 09:54
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86