django rest framework swagger 的测
2018-08-07 本文已影响289人
jarhmj
swagger有着自动生成API文档的功能,当然也可以测试。
自己在写APIView的时候,request的自己定义的参数是不能自己生成的,只有在path中的才可以,如何解决这个问题?
解决的思路:
翻看源码,原来get_swagger_view
返回的是schema
对象,也就是APIView
中的schema
属性,所以我们只要设置schema
就ok了。
class TestView(APIView):
'''
测试
'''
schema = AutoSchema(
manual_fields=[
coreapi.Field(name='code', required=True, location='form', description='', type='string'),
]
)
这个就是效果:
image.png现在可以通过Try it out
这个按钮来进行测试了,告别自己写API文档,告别自己用postman来测试,安心的码代码搬砖吧😏😏!!!
通过coreapi_Field中的location你可以设置任何参数,location有下列可选选项可以选:
"path" | "query" | "form" | "header" |
---|---|---|---|
包含在模板化URI中。例如,url值/products/{product_code}/可以与"path"字段一起使用。 | 包含在URL查询参数中。例如?search=sale。通常用于GET请求。 | 包含在请求正文中,作为JSON对象或HTML表单的单个项目。例如{"colour": "blue", ...}。通常的POST,PUT和PATCH请求。"form"单个链接上可以包含多个字段。 | 包含在请求头中,可以自定义。 |
具体操作请看DRF的文档schemas。