djangorestframework 可浏览 api：如何显示所有可用的端点 url？

Posted 2023-02-24

【中文标题】djangorestframework 可浏览 api：如何显示所有可用的端点 url？

【英文标题】：djangorestframework browsable api: how to show all available endpoints urls?

【发布时间】：2018-07-08 20:06:47

【问题描述】：

在 djangorestframework 中有一个可浏览的 api。但是我如何向用户展示他/她可以进行的所有可能的 API 调用的完整鸟瞰图？我现在一次只能看到一个，用户必须事先知道正确的 URL

即，

http://localhost:8000/users
http://localhost:8000/books
http://localhost:8000/book/1/author

谢谢！

【问题讨论】：

./manage.py show_urls 应该可以解决问题。 ***.com/questions/1275486/…

谢谢，但我的意思是我希望用户能够像其他人一样浏览我的 api。它应该显示我的整个 API 的目录。因为我想指着一个前端开发者说“这里是我的整个 api”。您可以使用 strongloop node.js api 来做到这一点。

你为什么不使用 rest-swagger 或 drfdocs？

我认为 REST 框架附带的可浏览 API 功能意味着实际浏览 API 是可以开箱即用的。正如我所见，没有什么可浏览的？通过浏览，我的意思是至少看到一个目录，其中概述了我的 API 中包含的内容

您可能想要swagger 之类的东西，swagger 为您提供了一个可浏览的界面，当用户查看您的所有端点和可用于每次调用的 http 动词时，它还使用您代码中的文档字符串记录自己。

【参考方案1】：

答案正如 Klahnen 所说。使用这个：

https://django-rest-swagger.readthedocs.io/en/latest/

它对我来说是开箱即用的，这正是我所希望的。 不过，我仍然认为，可浏览 API 一词意味着有一个目录可供 API 的使用者查看。这个应用程序是救命稻草，也许应该包括在内！