是否可以针对Django中的文档测试REST API？

Question

我使用Django REST Framework开发了RESTful API服务器，并且随着应用程序的成熟，实体签名有时会发生变化。

在为此应用编写测试时，我开始怀疑是否有工具可以按照文档中所述检查API是否返回数据，即用户实体包含所有必填字段等。

我知道有django-rest-swagger之类的API自动文档编制工具，也许还有一些工具可以帮助断言返回给用户的数据具有与文档相同的签名？

Answer 1

为什么不使用简单的单元测试进行测试？ 我假设您已将API网址正确映射到Django'u url_patterns。

然后，你可以简单地单元Django的REST框架对其进行测试的测试用例

这是一个代码段：从rest_framework.test导入APITestCase

class InboxNotificationForPlayerViewTest(APITestCase):
    def test_returns_delivered_inbox_notifications(self):
        """..."""
        response = self.client.get(reverse(
            'notifications-api:inbox-for-player', kwargs={'player_id': self.subscriber.player_id}
        ))

        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertItemsEqual(response.data, {
            'count': 3,
            'not_read': 2,
            'notifications': {
                'read': [
                    inbox_payload(classic),
                    inbox_payload(without_window)
                ],
                'not_read': [
                    inbox_payload(read)
                ]
            }
        })

我知道这可能是一个很长的解决方案，但我相信它将对您的未来开发有所帮助。 请注意，响应数据格式的每次更改都会在每次测试启动时进行跟踪。

Answer 2

有专门的API文档工具（例如Swagger： http : //swagger.io/ ）。 您也可以通过Google搜索“ API合同”。

您可以使用DREDD（ http://dredd.readthedocs.io/en/latest/ ）根据API规范验证服务器。

奖励文章： https : //blog.codeship.com/api-documentation-when-preferences-matter/