Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API 문서화 #11

Open
woohyun212 opened this issue Nov 11, 2021 · 0 comments
Open

API 문서화 #11

woohyun212 opened this issue Nov 11, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@woohyun212
Copy link
Contributor

Swagger로 API를 문서화 했으면 합니다.
금종 형이 만든 activities는 세부적인 respone-data 수정이 가능해서 좋은데,
단점이라면, 데이터를 어떠한 형식으로 넘겨줘야하는지에 대한 폼이 명시되있지 않아서,
front에서 일일이 확인해햐하는 단점이 있어요.

아래에서 Swagger로 API를 자동으로 문서화하는 글들이 있으니 참고해서 진행하면 될 것 같아요.

https://www.django-rest-framework.org/topics/documenting-your-api/

https://medium.com/towncompany-engineering/%EC%B9%9C%EC%A0%88%ED%95%98%EA%B2%8C-django-rest-framework-api-%EB%AC%B8%EC%84%9C-%EC%9E%90%EB%8F%99%ED%99%94%ED%95%98%EA%B8%B0-drf-yasg-c835269714fc

https://velog.io/@jacoblee19/Django-REST-Framework%EC%97%90%EC%84%9C-API-%EB%AC%B8%EC%84%9C-%EC%9E%90%EB%8F%99%ED%99%94%ED%95%98%EA%B8%B0

@woohyun212 woohyun212 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants