django 一开始没用 restfulapi 开发, 还能自动生成文档吗?
zzm88104 · 2023-02-02 09:37:04 +08:00 · 2315 次点击这是一个创建于 665 天前的主题，其中的信息可能已经有所发展或是发生改变。
一开始是想做个简单的小插件, 但后来功能越加越多.
需要跟前端合作, 需要告知他新 api 的使用方式. 现在是丢给他保存了 example 的 postman 让他自己看. 这种方式对前端友好吗?
文档肯定是最好, 但一条一条 api 写文档感觉比较低效, 只是用爱发电的小项目,也花不起太多时间.
不知道有没有事后补救的办法?
需要跟前端合作, 需要告知他新 api 的使用方式. 现在是丢给他保存了 example 的 postman 让他自己看. 这种方式对前端友好吗?
文档肯定是最好, 但一条一条 api 写文档感觉比较低效, 只是用爱发电的小项目,也花不起太多时间.
不知道有没有事后补救的办法?
7 条回复 • 2023-03-08 04:31:40 +08:00
 |
1
GTim 2023-02-02 09:46:32 +08:00
友好啊，没有比这个更直观了，前提是要告诉他们怎么用
|
 |
2
zombiecong 2023-02-02 09:50:05 +08:00
django restful framework + [swagger]( https://django-rest-swagger.readthedocs.io/en/latest/)
|
 |
4
zzm88104 OP @zombiecong #2 好的, 原来这个也能事后补救啊! 那我研究下, 谢谢!
|
|
5
GTim 2023-02-02 11:59:05 +08:00  1
@zzm88104 配合默契度最重要的是接口格式和字段的统一性，比如第一次 user_id 表示用户编号，created_at 表示创建时间，title 表示标题, name 表示名称，反过来也一样，比如名称就是 name 或者 title 或者 subject , 那么厉害的前端对结一两次后就知道啥回事了
|
 |
7
zeusho871 2023-03-08 04:31:40 +08:00 1
django-ninja-extra 导出 api doc ，可以在 apifox 里直接调试
|
Select Language