[Django] Swagger 연결하기 (+ postman)

2022. 9. 14. 18:06· Backend/Django
목차
  1.  
  2. Swagger Postman연결

Django swagger 연결

1. drf-yasg 다운

pip install drf-yasg

2. settings.py 에 추가

INSTALLED_APPS = [
    ...
    
    'drf_yasg',
    'rest_framework',
    
    ...
]

3. urls.py 에 아래 내용 추가

from django.urls import re_path
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
from rest_framework.permissions import AllowAny

schema_view_v1 = get_schema_view(
    openapi.Info(
        title="제목",
        default_version='v1',
        description="설명",
        terms_of_service="https://www.google.com/policies/terms/",
    ),
    public=True,
    permission_classes=(AllowAny,),
)

urlpatterns = [
	
    ...
    
    re_path(r'^swagger(?P<format>\.json|\.yaml)$', schema_view_v1.without_ui(cache_timeout=0), name='schema-json'),
    re_path(r'^swagger/$', schema_view_v1.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
    re_path(r'^redoc/$', schema_view_v1.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
]

# http://127.0.0.1:8000/swagger/
# http://127.0.0.1:8000/redoc/
# http://localhost:8000/swagger/?format=openapi

4. 서버를 실행 

python3 manage.py runserver

5. 주소로 접속 (8080으로 열었다면 8080으로~~)

http://127.0.0.1:8000/swagger/
http://127.0.0.1:8000/redoc/

 

Swagger Postman연결

1. 스웨거에서 링크 확인

http://localhost:8000/swagger/?format=openapi 

2. postman에서 import

 

'Backend > Django' 카테고리의 다른 글

[Django] s3 mp3 file upload(with boto3)  (0) 2022.09.21
[Django] s3 bucket image upload code  (0) 2022.09.19
[Django] ORM count  (0) 2022.08.04
[Django] yolov5 결과 로컬에 저장하지 않고 바로 s3에 저장하기  (0) 2022.08.04
[Django] Use Customized AI Model(yolov5) in Django  (0) 2022.08.04
  1.  
  2. Swagger Postman연결
'Backend/Django' 카테고리의 다른 글
  • [Django] s3 mp3 file upload(with boto3)
  • [Django] s3 bucket image upload code
  • [Django] ORM count
  • [Django] yolov5 결과 로컬에 저장하지 않고 바로 s3에 저장하기
lim.dev
lim.dev
* 깃허브: https://github.com/Ellie010707
코딩림* 깃허브: https://github.com/Ellie010707
lim.dev
코딩림
lim.dev
전체
오늘
어제
  • 분류 전체보기 (205)
    • Network (6)
    • Backend (31)
      • Django (8)
      • Spring Boot (22)
    • Frontend (3)
    • Coding Test (107)
      • Python (93)
      • Java (1)
      • C_C#_C++ (4)
      • SQL (8)
    • Security (40)
      • 해커스쿨_FTZ (19)
      • VM (6)
      • CodeEngn (11)
      • Linux (4)
    • Project (2)
    • etc (12)

블로그 메뉴

  • 홈
  • 태그
  • 미디어로그
  • 위치로그
  • 방명록

공지사항

인기 글

태그

  • 리눅스
  • linux
  • reversing
  • stolenbyte
  • 리버서
  • ftz풀이
  • 해킹
  • 해커스쿨
  • 리눅스마스터
  • 리버싱
  • 해커스쿨ftz
  • crackme
  • ftz
  • ftz 풀이
  • abex
  • ftz write up
  • CodeEngn
  • hacking
  • 코드엔진
  • ftz writeup

최근 댓글

최근 글

hELLO · Designed By 정상우.v4.2.0
lim.dev
[Django] Swagger 연결하기 (+ postman)
상단으로

티스토리툴바

단축키

내 블로그

내 블로그 - 관리자 홈 전환
Q
Q
새 글 쓰기
W
W

블로그 게시글

글 수정 (권한 있는 경우)
E
E
댓글 영역으로 이동
C
C

모든 영역

이 페이지의 URL 복사
S
S
맨 위로 이동
T
T
티스토리 홈 이동
H
H
단축키 안내
Shift + /
⇧ + /

* 단축키는 한글/영문 대소문자로 이용 가능하며, 티스토리 기본 도메인에서만 동작합니다.