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

› Django Project

› Django REST Framework

This topic created in 1220 days ago, the information mentioned may be changed or developed.

一开始是想做个简单的小插件, 但后来功能越加越多.

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

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

不知道有没有事后补救的办法?

API

文档

Postman

restfulapi

7 replies • 2023-03-08 04:31:40 +08:00

yemoluo

Feb 2, 2023

友好啊，没有比这个更直观了，前提是要告诉他们怎么用

zombiecong

Feb 2, 2023

django restful framework + [swagger]( https://django-rest-swagger.readthedocs.io/en/latest/)

zzm88104

Feb 2, 2023

@GTim #1 那就好, 那我应该可以不写文档了? 对方是个比我厉害多了的前端工程师

zzm88104

Feb 2, 2023

@zombiecong #2 好的, 原来这个也能事后补救啊! 那我研究下, 谢谢!

yemoluo

Feb 2, 2023

@zzm88104 配合默契度最重要的是接口格式和字段的统一性，比如第一次 user_id 表示用户编号，created_at 表示创建时间，title 表示标题, name 表示名称，反过来也一样，比如名称就是 name 或者 title 或者 subject , 那么厉害的前端对结一两次后就知道啥回事了

zzm88104

Feb 2, 2023

@GTim #5 明白了!谢谢 GTim

zeusho871

Mar 8, 2023

django-ninja-extra 导出 api doc ，可以在 apifox 里直接调试