Swagger

Swagger 사용 이유

FE와 BE의 원활한 소통을 통해 코드의 유지, 보수, 개발 속도를 모두 향상시킬 수 있는 방법이다.
Postman, dbeaver를 직접 켜서 사용하는 것보다 더 낫다.

base.py

base.py에 SWAGGER_SETTINGS 추가
JWT 토큰으로 authorization을 부여하였다.

SWAGGER_SETTINGS = {
    'USE_SESSION_AUTH': False,
    'SECURITY_DEFINITIONS': {
        'BearerAuth': {
            'type': 'apiKey',
            'name': 'Authorization',
            'in': 'header',
            'description': "JWT Token"
        }
    },
    'SECURITY_REQUIREMENTS': [{
        'BearerAuth': []
    }]
}

urls.py

swagger url을 ulrpatterns에 추가해준다.
schema_view를 활용해 custom하게 페이지 첫 화면을 설정할 수 있다.
redoc은 다른 UI를 보인다.

🦴

• requirements.txt 에 drf-yasg==1.21.7 추가를 잊지말자!
• pip install --upgrade setuptools
• base.py INSTALLED_APPS 에 'drf-yasg' 추가해야만 swagger templates을 가져올 수 있다.

schema_view = get_schema_view(
    openapi.Info(
        title="Lambda Genesis Api",
        default_version='Version : 1.0.0',
        description="Lambda Genesis Api 문서)",
        terms_of_service="~",
        contact=openapi.Contact(email="~"), # 부가정보
        license=openapi.License(name="Lambda"),     # 부가정보
    ),
    public=True,
    permission_classes=[permissions.AllowAny],
)
urlpatterns = [
    path(r'swagger(?P<format>\.json|\.yaml)/', schema_view.without_ui(cache_timeout=0), name='schema-json'),
    path(r'swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
    path(r'redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc-v1'),

Authorize

http://127.0.0.1:8000/swagger/

• login → id, password 입력

🔑JWT Token Receive

• Authorize : JWT <🔑 jwt token 입력> or Bearer <🔑 jwt token 입력>

‼️JWT” “Token // 형식으로 입력해야합니다.

gunicorn으로 띄우면 swagger 안보이는 이유?

https://velog.io/@may_soouu/nginx-swagger-ui

deployment.yaml 에서 위와 같이 django에서 실행하게끔 하여 dev 웹에서 사용이 가능하게끔 바꿔주었다.(eks 사용)

한번에 적용이 안되는 것을 보고 rancher를 확인하여 image가 업데이트가 안된 것을 확인하였다. argocd에서 sync를 사용해 update 후 접속하였더니 정상적으로 접속이 되었다.

TO DO

urls.py에서 if 문으로 디버깅 모드로 들어갈때만 swagger 볼 수 있게끔 해줘야함. (즉, dev mode일 때만 가능하도록 해줘야함.)

question, add student 같은 작업은 input 이 required함으로 수정이 필요하다.