作为研发如何使用Github Api？

今天药忘吃喽~ 2024-04-22 07:06 56阅读 0赞

#### 文章目录 ####

*  使用步骤
 *  账号创建
 *  进行开发者相关设置
 *  API操作
 *  演示
 *  Github API好处
 *  推荐的Github API

> ?个人主页: [个人主页][Link 1]  
> ?♀️个人介绍:每天进步一点点，生活变得好一点点。

> ?作为一位开发，不管是非工作的还是工作中的人士，或多或少都有和Github接触。下面我就讲一下如何调用Github的api，其中有一些功能还是蛮好的，对于大部分人来说算是福利了。

## 使用步骤 ##

**使用Github API可以遵循以下步骤：**

1.  创建用于开发测试的账号
2.  注册Github开发者账号并申请API Key，以便访问API。
3.  阅读Github API文档，了解API的功能和限制，并了解如何访问API中的不同资源。
4.  构建请求，使用适当的HTTP方法（GET，POST，PATCH等）访问API。请求的格式与资源的类型相关，请参阅文档以获得详细信息。
5.  处理API响应，将返回的数据解析为所需的格式（例如JSON）。
6.  错误处理，在API请求失败时处理错误。

## 账号创建 ##

> 如果用于用于开发或者测试，最好别基于原来的账号去操作，有可能会导致污染或者数据丢失，甚至可能导致账号风险操作。最好去创建一个新账号。

?点击跳转:[注册地址][Link 2]

## 进行开发者相关设置 ##

> 大概就几个步骤:进入开发者设置-> 创建访问token(创建的时候可以根据情况来选择权限)

![在这里插入图片描述][2c99f0f620ee4abc815c1efc85d8173c.png]  
![在这里插入图片描述][16a8c15f50854342a76dd710529050e9.png]

![在这里插入图片描述][630a15352433488689b40fffe954d977.png]

> 上述步骤生成`token`之后必须进行保存，失效后继续创建一个新的即可。

## API操作 ##

?点击跳转:[Github Api 文档地址][Github Api]

![在这里插入图片描述][c516caf71c764624a3c5a3e2940e743b.png]

> 如上图所示，可以根据版本和需求来点开对应的api文档，文档中提供三种方式，按照自己的需求来调用即可。

## 演示 ##

> 下面的示例是获取个人仓库的Api:

curl -H "Accept: application/vnd.github+json" \
      -H "Authorization: Bearer 你的token"\
      -H "X-GitHub-Api-Version: 2022-11-28" \
      https://api.github.com/user/repos

**请求结果**

![在这里插入图片描述][d0bbf71748cd4289ab7d91a05b465182.png]

## Github API好处 ##

**使用Github API可以带来以下好处：**

1.  自动化Github任务：使用API可以编写代码以自动执行Github任务，例如创建存储库，更新存储库标签，合并代码等。
2.  集成Github与其他工具：API可以帮助将Github与其他工具集成在一起，例如使用API提取Github数据以在其他工具中使用。
3.  创建Github应用：API可以帮助您创建基于Github的应用程序，以增强Github的功能。

## 推荐的Github API ##

1.  Repositories API：访问存储库信息，例如存储库名称，描述，标签，提交等。
2.  Issues API：管理存储库问题，例如创建，更新，关闭问题等。
3.  Pull Requests API：管理存储库拉取请求，例如创建，更新，合并等。
4.  Users API：访问Github用户信息，例如用户名称，邮件地址，仓库数量等。
5.  Organizations API：管理Github组织，例如创建，更新，删除组织等。

> 这仅是Github API的一小部分，有更多的API可用，请参阅Github API文档以获取详细信息。

[Link 1]: https://longfei.blog.csdn.net/?type=blog
[Link 2]: https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home
[2c99f0f620ee4abc815c1efc85d8173c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/ae55fd7ab7c7411597ba3eac04563042.png
[16a8c15f50854342a76dd710529050e9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/34690c72f52444758131d13ecf206e50.png
[630a15352433488689b40fffe954d977.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/7c7cb8b470fd4f5bba74792ec1db0812.png
[Github Api]: https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues
[c516caf71c764624a3c5a3e2940e743b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/502f99b771ef40c2b2cf94586426ce42.png
[d0bbf71748cd4289ab7d91a05b465182.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/55c18f102cd64587826f26d5ac84ae1f.png