Skip to content

API 문서화 #11

@woohyun212

Description

@woohyun212

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

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions