基于函数的视图中的文档字符串

时间:2018-12-03 08:30:33

标签: django swagger

如何将docstring添加到基于函数的视图中,以便在swagger UI中可见?我已经为每个API及其通过swagger创建的工作模式创建了一个手动模式,但是我需要在Swagger UI中添加文档字符串以及示例响应。 这就是我正在尝试的方式。但是没用。

**schema.py**
MySwagger=ManualSchema(fields=

[coreapi.Field(name="data", required=True, location="form",

type="array",description="list of preprocessing here",)],)


**view.py**

@api_view(['POST'])
@schema(MySwagger)
@renderer_classes([SwaggerUIRenderer])
def myView(requests):
"""
enter code here
View description here
"""
--code--


**url.py**
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='API')
pref='api/v1/'
urlpatterns = [
path('admin/', admin.site.urls),
url('^$',schema_view,name="swagger"),
url(pref+'callMyView$',views.myView,name ='autoMLTrainModel')
]

0 个答案:

没有答案