API 문서화

Authorization (Auth) - (필요한) 권한

 

Postman

Documentation에서 문서 작성하고,

send 눌러서 콜 한뒤 결과뜨면

save as example을 눌러서 지금 이 콜한 상태를 저장하며

해당 request하단에 example이 생긴다!

401 Unauthorized , 200 OK 등으로 이름을 바꿔주면 보기 편리

하지만 3인 이상부턴 유료라는거,,,

또, 다큐멘테이션에 가끔 에러가 있다.. 날라간다거나,,등의 자잘한 에러

그래도 써보는 것을 추천!

 

drf-spectacular

~/api/schema/swagger-ui/ 접속

로그인(http://api/v1/accounts/signin/) 눌러서

파라미터 value admin, admin1234 해주고나서 받은 access키를 복붙해서

화면 우측 상단에 Authorize눌러서 값 넣어주면

권한 인증이 된다!

 

 

@extend_schema(

tags=["Articles"],

description="Article 생성을 위한 API",

request=ArticleSerializer,

)

했을때 문제..

비즈니스로직이 들어가는 중요한 뷰 코드가 너무 길어짐..

 

저

@extend_schema( ... )

안의 내용을 다른 파이썬 파일에 작성하고,

그걸 불러와서 붙여주는 방식으로도 사용할 수 있다.

 

-> 손이 많이가고 문제가 많다..(유지보수 힘들어짐)

-> 많은 회사에서 이 자동화 api를 쓰지 않음.