openeuler/compliance API使用教程：如何集成合规扫描到你的开发流程

openeuler/compliance API使用教程：如何集成合规扫描到你的开发流程

【免费下载链接】complianceImprove community members compliance capability,define the rules, develop the tools and suuply services.项目地址: https://gitcode.com/openeuler/compliance

前往项目官网免费下载：https://ar.openeuler.org/ar/

openEuler / compliance项目致力于提升社区成员的合规能力，通过定义规则、开发工具和提供服务，帮助开发者在开发过程中轻松实现合规扫描集成。本文将详细介绍如何使用openeuler/compliance API，将合规扫描无缝融入你的开发流程，确保项目合规无忧。

一、认识貂蝉：openEuler合规扫描的核心工具

貂蝉是openEuler合规SIG组推出的开源合规SAAS服务网站，已收录多个许可证及其元数据，并面向开发者提供API接口和开源项目的在线合规扫描服务。它是集成合规扫描到开发流程的关键工具，能够帮助你高效地进行license查询、API调用以及开源项目在线合规扫描。

二、貂蝉API接口详解：开启合规扫描集成之旅

2.1 进入API查询界面

貂蝉网提供给开发者使用的API接口，可点击貂蝉网站右上角标签进入接口调用界面。

2.2 API调用参数获取

开发者可以根据其licenseID值查询其license相关信息，licenseID可在貂蝉网站相应license的url上获取。如Apache-2.0 license链接为：https://compliance.openeuler.org/license/617 ，则其licenseID为617。

2.3 API查询示例

输入参数为其licenseID值，可查询相应licenseID相关信息。以下演示获取其license name，SPDX格式的名称，以及license的相关标签：

query { license(licenseID : 617) { id, name, spdxName, licenseMainTags { id, mainTag { id, type, name, } } } }

点击界面中间的按钮，可显示其查询的标签信息。更多API特性及描述可参考右侧的docs。

三、集成合规扫描到开发流程的完整步骤

3.1 登录与授权

首先，点击右上角登录按钮：

在弹出的界面中，点击授权按钮，目前支持gitee和github两种授权方式。

授权完成后，界面显示个人用户看板信息，浏览的历史报告信息、历史license信息都可以在这里查看。

3.2 发起开源项目合规扫描

在“我浏览过的报告”一栏，输入开源项目的仓库地址和分支，点击扫描。

3.3 等待扫描完成

扫描时间的长短与项目的大小、项目文件数量有关，等待一段时间，扫描完成。

3.4 查看扫描结果

扫描完成后，点击Report ID即可查看扫描结果。扫描结果主要聚焦于开源项目的license和copyright风险问题，帮助你及时发现并解决合规隐患。

四、利用貂蝉提升开发合规效率

通过貂蝉提供的API接口和在线扫描服务，你可以将合规扫描集成到开发的各个阶段。在项目开发初期，可利用API查询依赖组件的license信息，确保使用合规的组件；在代码提交前，进行在线合规扫描，及时发现潜在的合规风险。这一完整的合规扫描流程，能够帮助你在开发过程中轻松实现合规管理，提升项目质量。

相关工具使用文档可参考：doc/tool_manuals/diaochan.md

【免费下载链接】complianceImprove community members compliance capability,define the rules, develop the tools and suuply services.项目地址: https://gitcode.com/openeuler/compliance