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

swagger docs #22

Open
ljy2855 opened this issue Jan 27, 2024 · 0 comments
Open

swagger docs #22

ljy2855 opened this issue Jan 27, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ljy2855
Copy link
Member

ljy2855 commented Jan 27, 2024

개발 중 API test 및 명세서 제공을 위해 swagger를 사용

배포중인 서버에서 API 명세서는 확인가능 (개발 끝나면 내릴 예정)
API docs

local에서 개발할때 자동으로 swagger가 활성화 되는데,
python manage.py runserver 이후
http://localhost:8000/swagger 로 접근가능

image

화면에서 구현한 API들을 테스트할 수 있는데, 일부 API들은 인증을 해야만 접근 가능한 경우들이 있음(ex 지원서 수정, 지원 결과 확인)

해당 경우 authorize 버튼으로 로그인을 진행 후에 해당 API 테스트

@ljy2855 ljy2855 added the documentation Improvements or additions to documentation label Jan 27, 2024
@ljy2855 ljy2855 moved this to Backlog in cspc apply Jan 27, 2024
@ljy2855 ljy2855 moved this from Backlog to Ready in cspc apply Jan 27, 2024
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
Projects
Archived in project
Development

No branches or pull requests

5 participants