Atlassian SDK를 사용한 REST API 브라우저

이번에 얻은 것

이번에는 이 REST API Browser의 시작과 사용 방법을 소개합니다.

무슨 물건이요?

Confluence와 JIRA에서는 가끔 명령선으로 사소한 일을 조작하려고 할 때가 있다.
Atlassian의 SDK를 사용하면 개발용 Confluence와 JIRA의 실례를 시작할 수 있습니다.
이 환경에서는 빠른 디버깅과 디버깅 등 개발 지원 기능이 있다.
REST API 브라우저도 REST 명령의 API를 브라우저에 표시하고 매개변수를 변경하여 데이터 송수신 테스트를 수행할 수 있습니다.
예전에는 리모트 API의 쏘프와 XML-RPC 문턱이 조금 높았지만 버전이 업그레이드되면서 REST가 수행할 수 있는 처리가 늘어났기 때문에 이런 처리를 자동화하고 싶어서...그렇다면 우선 REST API Browser를 사용하는 것이 좋습니다.
특히 HTTP의 요청/응답에 대한 원본 데이터도 화면에서 확인할 수 있고, 컬과 같은 Unix 명령에 API를 사용한 경우에도 참고할 수 있다.
하지만 본가에 정확한 정보가 있으니 영어가 어렵지 않은 분들은 꼭 보세요.

Using the REST API Browser (Atlassian Developers Document)

필요한 물건은?

Atlassian SDK가 필요합니다.SDK를 사용하여 Confluence와 JIRA의 로컬 개발용 서버를 시작하면 동시에 사용할 수 있습니다.
또 "SDK로 확인하기 싫고 뭔지 빨리 확인하고 싶다"며 클라우드 버전인 REST API Browser로 아틀라스틴이 다음 두 개를 제공했는데 이쪽도 부탁한다.

JIRA Cloud Edition: https://bunjil.jira-dev.com/plugins/servlet/restbrowser

Confluence Cloud Edition: https://bunjil.jira-dev.com/wiki/plugins/servlet/restbrowser

※ 실제 데이터가 없으면 응답을 원활하게 되돌릴 수 없지만 API 일람과 발송 테스트를 진행할 수 있습니다.

부팅 방법

SDK의atlas-run 명령이나atlas-debug를 통해 대상 프로그램을 시작하면 됩니다.
다음은 Stash의 예입니다.

### Confluenceの場合
## % atlas-run-standalone --product confluence

## 以下はStashの例
% atlas-run-standalone --product stash
Executing: /usr/share/atlassian-plugin-sdk-xxx/apache-maven-xxx/bin/mvn com.atlassian.maven.plugins:maven-amps-plugin:xxx:run-standalone -gs /usr/share/atlassian-plugin-sdk-xxx/apache-maven-xxx/conf/settings.xml -Dproduct='stash'
[INFO] Scanning for projects...
[INFO] 

...[中略]...

[INFO] [talledLocalContainer] Tomcat 7.x started on port [7990]
[INFO] stash started successfully in 243s at http://localhost:7990/stash
[INFO] Type Ctrl-D to shutdown gracefully
[INFO] Type Ctrl-C to exit

구문 및 서버가 시작되면 메시지에 나타나는 URL에 액세스합니다.

우선 일반 계정(기본admin)으로 로그인

화면 오른쪽 아래에 있는 도구상자 아이콘을 클릭하면 개발용 메뉴

가 나온다

REST API 브라우저 선택

REST API 브라우저의 소파가 호출되어 API 문서 목록 및 테스트 양식을 표시합니다.

캡처

POST, PUT, DELETE 테스트도 화면에서 수행할 수 있습니다.
다음은 Stash의 예입니다.

POST 접근 방식의 구현

예정된 프로젝트의 테스트에 창고를 추가합니다.
화면에 샘플의 요청 매개 변수(JSON)를 설정하고 그 다음에 어떤 항목인지 지정한 다음 단추를 보냅니다.
※ Request Body는 기본 데이터뿐만 아니라 화면도 수정/수정할 수 있습니다.

순조롭게 진행되면 일반적인 Stash 프로젝트의 창고 일람표에 위에서 작성한 창고가 추가됩니다.

Confluence의 경우입니다.
REST API로 사용할 수 있는 것이 그리 많지 않다.

명령줄에서

REST API가 활성화되어 있으면 API 문서에 따라 다른 언어나 클라이언트에서 호출할 수 있습니다.
다음은 curl에서 REST API에 액세스한 예입니다.

액션: 지정된 항목에 있는 창고 정보 가져오기

GET 방법으로 URL의 일부에 매개변수 포함

URL 모드: appi/1.0/project/{projectKey}/repos/{repositorySlug}

## リポジトリ情報の取得
%  curl --user admin:パスワード http://localhost:7990/stash/rest/api/1.0/projects/PROJECT_1/repos/my-repo
{"slug":"my-repo","id":11,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PROJECT_1","id":1,"name":"Project 1","description":"Default configuration project #1","public":false,"type":"NORMAL","link":{"url":"/projects/PROJECT_1","rel":"self"},"links":{"self":[{"href":"http://localhost:7990/stash/projects/PROJECT_1"}]}},"public":false,"link":{"url":"/projects/PROJECT_1/repos/my-repo/browse","rel":"self"},"cloneUrl":"http://admin@localhost:7990/stash/scm/project_1/my-repo.git","links":{"clone":[{"href":"http://admin@localhost:7990/stash/scm/project_1/my-repo.git","name":"http"},{"href":"ssh://git@localhost:7999/project_1/my-repo.git","name":"ssh"}],"self":[{"href":"http://localhost:7990/stash/projects/PROJECT_1/repos/my-repo/browse"}]}}

그런 다음 삭제 모드입니다.

작업: 지정된 프로젝트에 있는 저장소 삭제

URL의 일부에 DELETE 메서드로 매개변수 포함

URL 모드: appi/1.0/project/{projectKey}/repos/{repositorySlug}

## 削除実施
%  curl --user admin:パスワード -X DELETE http://localhost:7990/stash/rest/api/1.0/projects/PROJECT_1/repos/my-repo
{"context":null,"message":"リポジトリは削除予定です。","exceptionName":null}% 

## 確認
%  curl --user admin:パスワード http://localhost:7990/stash/rest/api/1.0/projects/PROJECT_1/repos/my-repo
{"errors":[{"context":null,"message":"リポジトリPROJECT_1/my-repoは存在しません。","exceptionName":"com.atlassian.stash.exception.NoSuchRepositoryException"}]}

무사히 사라지다.

요약/고려 사항 등

간단한 REST API Browser 소개
Using the REST API Browser의 끝에 쓰인 바와 같이 자바에 설치된 플러그인에 REST API가 있으면 REST API 브라우저에 자동으로 API 정보가 표시됩니다.
안타깝게도 나는 그렇게 많은 개발을 할 수 없어서 이 부근에서는 아직 확인하지 못했다.

주의점

SDK로 제품을 시작하면 기본적으로 각 제품의 최신 버전이 시작됩니다.
그러나 실제 환경(공식 환경)에서는 버전이 오래된 경우가 많기 때문에 사용할 수 없는 API가 있으니 주의하십시오.
또한 API 일람표에는 나타나지 않지만 브라우저 로그에서 항상 사용할 수 있다고 생각하는 API, 요청 모드를 찾을 수 있습니다.이 경우 버전이 업그레이드되면 오히려 사용할 수 없을 수도 있으니 주의하세요.