Django Rest Framework 电商项目 9-1 DRF的API文档自动生成

到现在,我们已经有不少接口了,是时候用一下DRF给我们提供的文档了。我们已经配置过它了,docs。

我们来访问:

http://127.0.0.1:8000/docs/

我们可以利用这个文档来做测试,每个接口的每种方法都可以使用。

点击左下角javascript后,右侧有生成的js代码,前端可以直接拿过去用。文档是依据我们在根url中所配置的生成的。

关于文档的中文说明,参见官方文档:Documenting your views

变量的Description可以在model中,添加help_text来完成。也可以在serializer中写。在filter中也可以写。

需要用户认证的,可以先在左侧的athentication中操作。

发布了101 篇原创文章 · 获赞 26 · 访问量 1万+

猜你喜欢

转载自blog.csdn.net/liujh_990807/article/details/99360449