소개

새로운 API와 함수를 사용할 때,
자신이라면, 그 API나 함수를 구그하고, 누군가가 쓴 알기 쉬운 해설 기사를 사용해 보는 것이 많다.

그러나 기사에는 일부 정보가 픽업되고 있거나 하고 싶은 정보가 생각대로 얻을 수 없는 것이 많이 있다.

그런 때는 공식 문서를 보면 모두 써 있다는 것을 최근 깨달았다.
분명 그런 사람은 자신만이 아닐 것. (라고 믿는다.)

무엇을 썼는지

이번은 Slack의 files.upload를 예로 읽는 방법을 소개했다.

많은 공식 문서에는 건네받는, 필수 혹은 임의의 인수나, 반환값이 쓰여 있다.
또, API라면 사용하는데 필요한 설정도 쓰여져 있어, 곤란하면 한 번 공식으로 되돌아 보는 것을 추천한다.

files.upload 공식 문서

이번에는 "files.upload"의 공식 문서를 바탕으로,
구축에 필요한 정보를 발췌하고(라고 할까, 자신이 전부 읽고 있지 않을 뿐이지만) 소개한다.

문서는 아래 URL을 참조하십시오.
htps : // 아피. scck. 코 m/메오 ds/후우 s. ㄹぉ아 d

Facts

문서상에 있는 "Facts"에는 대상의 API의 기본정이 기재되어 있다.

MethodURL
프로그램이 던져야 할 URL이 기재되어 있다. 프로그램은 MethodURL을 기반으로 쿼리를 만듭니다.

Preferred HTTP method
추천되는 HTTP 메소드가 기재되어 있다. "POST"라고 기재되어 있으면,
권장대로 POST 메소드로 요청을 보냅니다.

Accepted content types
허용 가능한 콘텐츠의 유형이 설명됩니다.
content types를 지정할 때는 어느 쪽인가를 사용하면 된다.

rate limiting
속도 제한의 것 같다 (이 항목에 관해서는 특별히 필요로 한 적이 없다)
"Tier2"의 경우, 20회/min의 리퀘스트가 보증되는 것 같다.
※ 항목을 클릭하면 자세한 내용을 볼 수 있습니다

works with
구축하는 API App에 부여하는 권한이 기재되어 있다. Bot/User 어느 쪽으로 구축할 때라도 "files:write"의 권한을 붙일 필요가 있다.

API App에의 권한 부여에는 OAuth 스코프를 지정하면 된다.
상세한 설정 방법은 다음과 같습니다.　
ht tp // tf sf. bぉg. jp / archi s / 1074688701. HTML

Arguments

Arguments에는 인수가 기재되어 있다.
수가 많기 때문에 모든 소개는 피하지만, 이것들 중 적어도 "Required"를 지정한다.

예를 들어, token은 반드시 필수로 channels에는 채널명 혹은 ID를,(복수 지정이면, 콤마 단락으로) 인수로서 설정할 수 있다

Response

Response에는 반환값의 형식과 내용의 예가 기재되어 있다.
인수에 필요한 값이 있으면 여기를 참조하십시오.


덧붙여서, 에러가 발생했을 때의 반환 값에 대해서는 아래와 같이 돌아옵니다.
"ok":false에 요청이 실패했으며,
또한, "error"에는 그 내용이 기재되어 있다.

오류

마지막으로, Error의 설명을 한다.
Error에는 문자 그대로, 에러 내용이 기재되어 있다.
요청이 실패하면 반환 값의 "error"에서 해당 내용을
찾으면 해소 방법의 힌트가 될 것이다.

마지막으로

이상이 files.upload 공식 문서를 읽는 방법의 소개이다.
공식을 읽으면 모든 것이 해결되는 것은 아니지만,
적어도 발걸음이 될 것이라고 생각하기 때문에,
막히면 공식 문서를 한 번 보는 것이 좋습니다.