В этом блоге я покажу вам, как генерировать документацию вашего Django API через 2 мин. Давайте начнем,
Есть много инструментов, доступных для создания документов для API для отдыха, но я предпочитаю что-то простое и ясное.
Для этого я создал фрагмент Модель со следующими настройками,
Models.py файл,
from django.db import models
class Snippet(models.Model):
created = models.DateTimeField(auto_now_add=True)
title = models.CharField(max_length=100, blank=True, default='')
serializer.py файл,
from rest_framework import serializers
from .models import Snippet
class SnippetSerializer(serializers.ModelSerializer):
class Meta:
model = Snippet
fields = '__all__'
Просмотр .py файл,
from rest_framework import viewsets
from .models import Snippet
from .serializer import SnippetSerializer
class SnippetViewSet(viewsets.ModelViewSet):
"""
This viewset automatically provides `list`, `create`, `retrieve`,
`update` and `destroy` actions.
"""
queryset = Snippet.objects.all()
serializer_class = SnippetSerializer
Давайте предоставляем конечную точку URL для нашей документации API,
from .views import SnippetViewSet
from django.urls import include, path
from rest_framework.routers import DefaultRouter
from rest_framework.documentation import include_docs_urls
router = DefaultRouter()
router.register(r'snippet', SnippetViewSet)
urlpatterns = [
path('api/', include(router.urls)),
path('docs/', include_docs_urls(title='Snippet API'))
]
Примечание что док-струны предусмотрены в Просмотр .py Файл будет использоваться для нашей документации, поэтому, пожалуйста, предоставьте столько информации, сколько сможете.
Теперь ваша документация API можно найти в http://localhost: 8000/Документы Отказ
Счастливое кодирование!
Ссылка
Оригинал: “https://dev.to/iamtekson/generate-api-docs-for-django-rest-framework-1cke”