10+ Django Swagger 使い方 Article

GitHub assemch/djangoswaggerui Django swagger UI is a viewer for from github.com

Introduction

Django is a powerful web framework used by many developers worldwide to build web applications quickly and efficiently. One of the most popular tools used in conjunction with Django is Swagger, a tool that helps you document your APIs and provides a user interface for testing them. In this article, we will discuss how to use Django Swagger effectively in 2023.

Installation

The first step in using Django Swagger is installing it. You can install it using pip by running the following command:

pip install django-rest-swagger

Configuration

After installing Django Swagger, you need to configure it in your Django project. To do this, you need to add the following lines to your project's settings.py file:

INSTALLED_APPS = ( ... 'rest_framework', 'rest_framework_swagger', ... )

URL Configuration

Next, you need to include the Django Swagger URLs in your project's urls.py file. You can do this by adding the following lines:

from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title='API Documentation') urlpatterns = [ ... url(r'^docs/$', schema_view), ... ]

Using Django Swagger

After configuring Django Swagger, you can start using it to document your APIs. To do this, you need to add Swagger documentation to your API views. You can do this by adding the following lines to your view:

from rest_framework.decorators import api_view, renderer_classes from rest_framework_swagger.renderers import OpenAPIRenderer, SwaggerUIRenderer @api_view() @renderer_classes([SwaggerUIRenderer, OpenAPIRenderer]) def my_view(request): ...

Documenting Your API

Once you have added Swagger documentation to your API views, you can start documenting your API using Swagger annotations. These annotations can be added to your view's function definition or to your serializer's class definition. Some examples of Swagger annotations are:

@swagger_auto_schema(method='post', request_body=MySerializer)

@swagger_auto_schema(method='get', responses={200: MySerializer})

Testing Your API

One of the most useful features of Django Swagger is its built-in user interface for testing APIs. To access this interface, go to the following URL in your browser:

http://localhost:8000/docs/

From here, you can test your API by sending requests and viewing the responses.

Customizing Django Swagger

If you want to customize the look and feel of the Django Swagger user interface, you can do so by creating a custom template. To do this, create a new file called swagger-ui.html in your project's templates directory and add the following code:

{% extends "rest_framework_swagger/base.html" %} {% block swagger_ui %}

{% endblock %}

Conclusion

Django Swagger is a powerful tool that can help you document your APIs and test them quickly and efficiently. By following the steps outlined in this article, you can start using Django Swagger effectively in your Django project in 2023.