/ / Cómo mostrar la descripción de la API con django_rest_swagger 2.1.1 - django, django-rest-framework, swagger-2.0, django-rest-swagger

Cómo mostrar la descripción de la API con django_rest_swagger 2.1.1 - django, django-rest-framework, swagger-2.0, django-rest-swagger

Para la versión 0.3, DRF puede leer datos de información en configuraciones swagger y renderizar en UI swagger.

SWAGGER_SETTINGS = {
......
"info": {
"contacto": "xxxxx@github.com",
"description": "Este documento intenta describir todas las API de Restful.",
"título": "documento de la API de GSLB",
}
"USE_SESSION_AUTH": Verdadero
}

¿Pero para la versión 2.1.1, parece que el campo de información no es compatible con swagger_settings? El título se puede pasar de la siguiente manera:

schema_view = get_swagger_view (title = "My Restful API")

Pero parece que no hay forma de pasar la descripción a get_swagger_view, por lo que no puedo mostrar la descripción en la interfaz de usuario de Swagger. ¿Hay una solución en esta versión? Gracias.

Respuestas

0 para la respuesta № 1

Para las versiones actuales de Django Rest Framework Swagger, agregar comentarios a la cadena de documentos parece funcionar (por ejemplo, se muestran como descripciones en documentos de Swagger).

class MyExport(mixins.ListModelMixin, viewsets.GenericViewSet): """ A really cool function"""

Y "Una función realmente genial" se muestra como la descripción en una vista arrogante.