모든 프로젝트 V1 API를 REST API로 전환하는 마이그레이션 가이드 목록(마이그레이션이 완료됨)
서비스 종료
2023년 6월 22일, Snyk이 공지하며 프로젝트 목록 V1 API의 종료 일정을 공개했으며, 이 API는 2023년 12월 22일에 서비스 종료될 예정이며, REST 프로젝트 목록 API를 대신 사용하라고 권장합니다.
REST 프로젝트 API의 새로운 기능은 무엇인가요?
OpenAPI 사양에 따라 Snyk REST API는 일관되고 사용하기 쉬운 API 프레임워크를 제공하기 위해 설계되었습니다. 새 API의 장점은 다음과 같습니다:
일관된 버전 관리
페이지네이션 및 캐싱
향상된 성능
클라이언트 생성
프로젝트 REST API는 향상된 데이터 아키텍처를 도입하여 성능을 향상시키고 도메인 간 분리를 용이하게 합니다.
Snyk은 새 API로의 마이그레이션이 중요한 작업일 수 있음을 이해하고 프로세스 전반에 지원하려 합니다. 이 포괄적인 마이그레이션 가이드는 단계별 지침, 코드 예제 및 새 API와의 원활한 통합을 위한 모범 사례를 제공하여 원활한 전환을 용이하게 합니다.
만약 당신이 더 이상 사용되지 않는 엔드포인트를 사용 중이라면, Snyk은 이 마이그레이션 가이드를 검토하고 2023년 12월 22일 금요일 이전에 모든 자동화를 옮기도록 권장합니다.
REST API로의 마이그레이션 타임라인
마이그레이션 가이드가 발행되고 v1과 REST 프로젝트 API의 상세한 비교 제공
2023년 6월 22일
마이그레이션 가이드를 검토하고 마지막 날짜 이전에 기존 코드 및 워크플로를 마이그레이션할 계획을 세웁니다.
프로젝트 목록 v1 API는 이제 410 Gone을 반환합니다:
Enterprise 플랜에서 모든 새로 생성된 그룹에 대해
Snyk API에 액세스할 수 있는 다른 플랜에서 새로 생성된 모든 조직에 대해
2023년 6월 22일
기존 엔터프라이즈 플랜 사용자에게는 조치가 필요없습니다.
새로운 사용자는 모든 새 통합을 위해 REST 프로젝트 API를 사용해야 합니다.
Snyk 도구
2023년 8월 15일
Snyk 도구를 사용하는 고객은 v1 대신 REST 프로젝트 API를 사용할 수 있는 버전으로 업그레이드해야 합니다.
이 가이드에 포함된 자세한 목록을 참조하십시오.
서비스 종료: 프로젝트 목록 v1 API에 대한 모든 액세스는 410 Gone 응답을 반환합니다.
2023년 12월 22일
자동화된 워크플로르에 중단을 피하기 위해 이 시간까지 마이그레이션이 완료되었는지 확인하십시오.
다음 Snyk Tools가 프로젝트 목록 v1 API 대신 REST 프로젝트 목록 API을 사용하도록 업데이트되었습니다:
snyk-jira-tickets-for-new-vulns: 버전 5.0.0 이상
snyk-api-ts-client: 버전 1.11.1 이상
snyk-request-manager: 버전 1.8.1 이상
backstage-plugin: 버전 2.0.0 이상
api-import-tool: 버전 1.99.0 이상
snyk-scm-mapper: 최신 버전
pysnyk: 버전 0.9.8 이상
snyk-repo-diff: 최신 버전
snyk delta: 버전 1.9.0 이상
snyk-issues-to-csv: 최신 버전
snyk-disallow: 이 도구는 더 이상 사용되지 않음
snyk-prevent-gh-commit-status: 버전 2.2.1 이상
다양한 CX Tools 코드 샘플이 업데이트되었습니다.
v1에서 REST 프로젝트 API로의 비교
org.name
data[i].relationships.organization.links.related - 데이터 조직에 대해 더 많은 데이터를 검색할 REST API 링크를 제공합니다. REST GET /orgs/:org_id
org.id
data[i].relationships.organization.data.id - 더 많은 데이터를 검색할 수 있도록 REST API 링크를 사용하거나 REST GET /orgs/:org_id을 이용할 수 있습니다.
name
data[i].attributes.name
created
data[i].attributes.created
origin
data[i].attributes.origin
type
data[i].attributes.type
readOnly
data[i].attributes.read_only
testFrequency
data.[i].attributes.settings.recurring_tests.frequency
totalDependencies
선택적으로 meta.latest_dependency_total 쿼리 매개변수를 지정하여 검색할 수 있습니다.
issueCountBySeverity.low issueCountBySeverity.medium issueCountBySeverity.high issueCountBySeverity.critical
선택적으로 meta.latest_issue_counts 쿼리 매개변수를 지정하여 검색할 수 있습니다.
imageId
최신 프로젝트 스냅샷을 통해 얻을 수 있습니다. v1 POST org/:orgId/project/:projectId/history
imageTag
최신 프로젝트 스냅샷을 통해 얻을 수 있습니다. v1 POST org/:orgId/project/:projectId/history
imageBaseImage
최신 프로젝트 스냅샷을 통해 얻을 수 있습니다. v1 POST org/:orgId/project/:projectId/history
imagePlatform
최신 프로젝트 스냅샷을 통해 얻을 수 있습니다. v1 POST org/:orgId/project/:projectId/history
imageCluster
데이터[i].target.data.id - 이 관계를 확장하거나 REST Targets API로 별도 API 호출을 수행하여 일치하는 대상을 가져와 클러스터 데이터를 가져올 수 있습니다.
remoteRepoUrl
데이터[i].relationships.target.data.attributes.url - 대상 관계를 확장하기 위해 확장 매개변수를 사용합니다.
lastTestedDate
meta.latest_dependency_total.updated_at 또는 meta.latest_issue_counts.updated_at - 선택적으로 meta.latest_issue_counts 또는 meta.latest_dependency_total 쿼리 매개변수를 지정하여 검색할 수 있습니다.
owner.id
owner.name
owner.username
owner.email
data[i].relationships.owner.links.related -
수입 사용자에 대한 자세한 데이터를 검색하기 위한 REST API 링크를 제공합니다. REST GET /orgs/:org_id/users/:id (beta)
browseUrl
사용자/프로젝트 ID https://app.snyk.io/org/:orgSlug/project/:projectId를 사용하여 조직 슬러그와 프로젝트 ID를 조합할 수 있습니다.
importingUser.id
importingUser.name importingUser.username importingUser.email
data.[i]relationships.importer.data.id,
data[i]relationships.importer.links.related
추가로 수입 사용자에 대한 자세한 데이터를 검색하기 위한 REST API 링크를 제공합니다. REST GET /orgs/:org_id/users/:id (beta)
isMonitored
data[i].attributes.status
branch
data[i].attributes.target_reference
targetReference
data[i].attributes.target_reference
"tags": [ { "key": "example-tag-key", "value": "example-tag-value" } ]
data[i].attributes.tags[ { "key": "example-tag-key", "value": "example-tag-value" } ]
attributes.criticality
data[i].attributes.business_criticality
attributes.environment
data[i].attributes.environment
attributes.lifecycle
data[i].attributes.lifecycle
필터
이름으로 필터링 제공된 경우, 해당 값으로 시작하는 이름을 가진 프로젝트만 반환됩니다.
필터: names 제공된 이름과 일치하는 프로젝트를 반환합니다.
일치하는 대상을 찾기 위해 REST Targets API를 사용한 후 대상 ID를 기반으로 프로젝트를 필터링할 수 있습니다.
추가 API 호출 없이 필터링하려면 조직의 프로젝트의 모든 관련 대상 데이터를 확장할 수 있도록 REST List all projects에 대한 확장 매개변수를 사용하세요.
Last updated