net-gitee

介绍

net-gitee is the .Net SDK of Gitee OpenAPI.

Gitee API地址

实现功能

• socket
• CodeGen
• 模型搬运（ 由于Gitee文档存在一定问题，加上本人时间不足，可能比较拖沓。）
• 全面的使用文档
• Web调用示例
• 全面的说明文档
• webhook模型
• webhook签名验证
• Api调用
• 授权设计
• 模型设计
• 框架设计

软件架构

• CodeGen（代码生成器-目前主要生成请求模型）
  • Template（模板）
    • Class
    • Property
  • GiteeApi-json（Gitee的SwaggerJson文件：入口）
  • Swagger-V2 Model
• Console（控制台程序-主要测试一些接口还原和实现）
• GiteeOpenSdk（核心程序）
  • Common（用到的简单工具包）
  • Models（Api模型-从CodeGen导入，不建议修改，请使用partial扩展）
    • Base（重用的一部分模型）
    • Request（请求模型）
    • Response（返回模型）
    • 其他（基础模型和授权模型）
  • Services（核心服务）
  • WebHook（WebHook钩子支持）
    • Models（钩子模型）
    • SignVerification（验证签名）
• Sample（Web实践示例代码） （待更新）
  • Sdk调用样例
  • WebHook样例

最佳实践（后续会逐渐开源）

• 开始任务自动创建分支并关联（已实现，完善后开源）
  • 解析WebHook(issue_state_change)
  • 查询分支
  • 创建分支
  • 任务关联分支
• 任务审核自动创建PR（规划中）
• PR审核自动关闭关联任务（现在要在pr内容中手动输入#IssueID来关联任务）（规划中）
• 里程碑提醒&任务到期提醒（轮询）

安装教程（待更新）

使用说明（待更新）

注意

• 模型使用partial部分类（可自扩展）
• 模型命名规范：基于swagger.json的operationId字段

🥗 环境要求

• Visual Studio 2019 16.8 +（或mac版）
• .NET 5 SDK +
• .Net Standard 2.1 +(待更新)

🍻 贡献代码

net-gitee 遵循 Apache-2.0 开源协议，欢迎大家提交 PR 或 Issue。

如果要为项目做出贡献，请查看 贡献指南。