Useless Facts API 사용에 대한 간단한 가이드

그래서 질병으로 인한 고통과 절망으로 가득 찬 2주 동안 django rest framework에서 간단한 API를 만들었습니다.
자체에 대해 배우고 토큰 인증, 범위 지정 비율 제한, API 문서화 방법과 같은 개념을 적용하여 몇 가지 예를 들 수 있습니다.

이제 데이터를 얻는 것이 그다지 저렴하지 않다는 것을 깨닫고 다른 사람의 웹사이트를 스크랩하는 것도 웹사이트에 불필요한 부하를 줄 수 있습니다.
그리고 그들의 지갑, 내가 수집한 모든 데이터를 이 API를 통해 다른 모든 사람이 사용할 수 있도록 만들고 있습니다.

이러한 API를 사용하는 단계

1단계: /auth/login/ 끝점을 호출하거나 새 사용자인 경우 /auth/registration/를 호출하여 토큰을 다시 받습니다.

참고 - 모든 데모는 httpie을 사용하여 수행되지만 swagger 문서here에서 curl을 사용하여 수행하는 방법을 확인할 수 있습니다.

http POST https://uselessfacts.fly.dev/auth/login/ username=<your-registered-username> password=<your-registered-password>

또는

http POST https://uselessfacts.fly.dev/auth/registration/ username=<your-choice-of-username> password1=<your-choice-of-password>  password2=<same-as-password1>

다음과 같은 응답을 받게 됩니다.

{
    "key": "c596a03fd15783e14d512c843a7ee4ba84ea77eb"
}

이것이 우리가 이야기한 토큰입니다.

2단계: v1 API를 호출하는 동안 이 토큰을 승인으로 전송하여 쓸데없는 사실을 다시 얻습니다!

http POST https://uselessfacts.fly.dev/v1/random-fact/ 'Authorization: Token c596a03fd15783e14d512c843a7ee4ba84ea77eb'

또는

http POST https://uselessfacts.fly.dev/v1/fact/145/ 'Authorization: Token c596a03fd15783e14d512c843a7ee4ba84ea77eb'

그리고 요청이 성공하면 아래와 같이 쓸모없는 사실을 얻게 됩니다.

{
    "data": {
        "fact": "California consumes more bottled water than any other product.",
        "id": 145
    },
    "status": "success"
}

swagger 설명서here에서 다른 응답을 확인할 수 있습니다.

이제 가장 중요한 단계, 좋은 사람처럼 여러분도 로그아웃하세요!

3단계: 이전 단계에서 수행한 것처럼 인증에서 토큰을 전송하여 본문이 없는 엔드포인트/auth/logout/를 호출하여 로그아웃합니다.

http POST https://uselessfacts.fly.dev/auth/logout/ 'Authorization: Token c596a03fd15783e14d512c843a7ee4ba84ea77eb'

요청이 성공하면 다음과 같은 응답을 받아야 합니다.

{
    "detail": "Successfully logged out."
}

위에서 언급한 swagger 문서에서 모델뿐만 아니라 사용 가능한 다른 모든 끝점을 탐색할 수 있습니다.

여기 또는 OR에서 저에게 연락하실 수 있습니다!