backlogAPI 문서, 이해하기 어렵지?

디스는 죄송합니다. 뭔가 하려고 하면 언제나 세세한 곳에서 망설인다.
명문화되지 않은 것이 많지 않습니까? ?
그리고 에러의 반환이 모두 400의 Bad Request인 것도 위장한다.

URL에 대한 참고 사항

API 키

GET, POST, PATCH, DELETE 모두에서 GET 매개 변수로 apikey = XXX가 필요합니다.
POST, PATCH, DELETE의 경우도 그렇기 때문에 주의.

URL 정확성

URL 전반, URL의 끝에 "/"가 붙으면 에러가 되므로 주의.
예)
과제 추가 API (POST)

NG： https://XXX.backlog.jp/api/v2/issues/?apiKey=XXXX
OK： https://XXX.backlog.jp/api/v2/issues?apiKey=XXXX
                                      ^^^←ここ

과제 추가, 편집 빠짐

일반

문서에 작성된 요청 매개변수 이외의 매개변수가 포함된 경우 400 BadRequest 오류.

과제 추가 API(POST)

URL

/api/v2/issues
※ 물론 파라미터에 apiKey=XXX 가 필요합니다.

필수 항목

매개변수 이름
금형
내용


projectId (필수)
수치
과제를 등록하는 프로젝트 ID

summary (필수)
문자열
과제 제목

issueTypeId (필수)
수치
과제 유형 ID

priorityId(필수)
수치
과제 우선 순위 ID


priorityId는, 모든 백로그로 공통의 값 "3"(중)을 사용할 수 있으므로 아직 좋다.
issueTypeId는 각 프로젝트마다 다르므로 기합으로 찾을 필요가 있다.
게다가 과제 일람의 취득 API에서 issueTypeId, priorityId는 반환되지 않는다.
issueType.id, priority.id 형태로 반환됩니다. IN과 OUT 제대로 해 주었으면 한다.
그렇다면 원래 그들이 필수적인 의미입니까? ?

과제 정보 업데이트 API(PATCH)

URL

/api/v2/issues/:issueIdOrKey
※ 물론 파라미터에 apiKey=XXX 가 필요합니다.

이:issueIdOrKey 귀찮은. 문서에는 이렇게 적혀 있습니다.

URL 매개변수


매개변수 이름
금형
내용


issueIdOrKey
문자열
이슈 ID 또는 이슈 키


우선, 이런 쓰는 방법이라면 apiKey를 get 파라미터로 필수라고 써 주었으면 좋겠다.
이 문서에서 「과제의 ID」, 「과제 키」라는 말은 아마 나오지 않았죠.
과제 일람의 취득으로 취할 수는 있습니다만, 그쪽에서도 리스폰스 정보의 해설이 없기 때문에
어느 것이 ID로 어느 것이 키인가는 한눈에는 모른다.
응답 ID, 도전 ID, issueKey, 도전 키와 같습니다.

과제 정보 업데이트 API, 최대 참고 사항

무려, 「업데이트하는 정보가 없었던 경우는 에러:400 BadRequest를 반환한다」!!!!!!!
보통 정상 종료가 아닌가?

요약

모두 API를 만들 때는 문서를 제대로 쓰자.
이 책은 매우 상어가되었습니다.
이 생각, 백 로그의 사람에게 전달