도메인

파이썬 웹서버 REST API 문서 쉽고 빠르게 작성하기 - 이용선 - PyCon.KR 2019

페이지 정보

작성자 PyCon Korea 작성일19-09-20 00:00 조회17회 댓글0건

본문



발표자 : 이용선
발표 자료 : https://www.slideshare.net/YongseonLe...

웹 프론트엔드의 규모가 커지고 아키텍쳐가 고도화됨에 따라, Django template이나 Jinja2와 같은 템플릿을 백엔드에 포함하기보다는 프론트엔드를 React나 Vue를 이용하여 따로 나눠서 개발하는 경우가 많아지고 있습니다. 이런 경우 백엔드, 프론트엔드 프로그래머가 서로의 코드를 계속 파악하기 힘들기 때문에 API 문서를 작성하여 꼭 필요한 부분만 공유하는 것이 효율적입니다.

직접 손으로 API 문서를 작성할 수도 있지만 규모가 크거나 빠르게 개발중인 프로젝트에서는 관리하기가 힘듭니다. 따라서 소스코드만 수정해주어도 자동으로 문서가 생성되도록 할 수 있다면 굉장히 편리한데, 이렇게 하기 위해서 보통 Swagger OpenAPI Specification에 맞게 JSON/YAML을 생성한 뒤에 이것을 파싱해서 문서 페이지를 그리는 방법을 사용합니다. 예를들어 DRF Yet Another Swagger Generator, Flask-RESTPlus와 같은 프로젝트가 이 방법을 사용합니다.

이 발표에서는 OpenAPI JSON/YAML을 생성하기 위해 필요한 것들과, Django, Flask 등 Python web framework를 사용할 때 어떻게 하면 OpenAPI JSON/YAML을 편하게 생성할 수 있는지 소개합니다.

PyCon Korea 2019 프로그램 자세히 보기 : https://www.pycon.kr/2019/program/tal...

댓글목록

등록된 댓글이 없습니다.

Total 111건 1 페이지
  • RSS
게시물 검색
Copyright © www.modosi.kr. All rights reserved.  Contact : help@oxmail.xyz