go-redmine 技术文档

本文档将详细介绍如何安装、使用以及调用 go-redmine 项目提供的 API，帮助用户更好地理解和运用这个 Redmine 接口项目。

1. 安装指南

安装 go-redmine 非常简单，只需要使用 go 命令行工具执行以下命令：

go get github.com/mattn/go-redmine

该命令将会将 go-redmine 项目下载到本地，并安装所需的依赖。

2. 项目使用说明

go-redmine 项目提供了一个命令行工具 godmine，可用于对 Redmine 进行操作。以下是 godmine 的基本使用方法：

首先，安装 godmine：

go install github.com/mattn/go-redmine/cmd/godmine@latest

然后，根据需要执行不同的命令。以下是项目命令和问题命令的基本用法：

项目命令

• add：使用文本编辑器创建项目。

  godmine p a
  

• create：从给定的参数创建项目。

  godmine p c name identifier description
  

• update：更新指定项目。

  godmine p u 1
  

• show：显示指定项目。

  godmine p s 1
  

• delete：删除指定项目。

  godmine p d 1
  

• list：列出所有项目。

  godmine p l
  

问题命令

• add：使用文本编辑器创建问题。

  godmine i a
  

• create：从给定的参数创建问题。

  godmine i c subject description
  

• update：更新指定问题。

  godmine i u 1
  

• show：显示指定问题。

  godmine i s 1
  

• delete：删除指定问题。

  godmine i d 1
  

• close：关闭指定问题。

  godmine i x 1
  

• notes：向指定问题添加备注。

  godmine i n 1
  

• list：列出所有问题。

  godmine i l
  

3. 项目 API 使用文档

go-redmine 项目提供了对 Redmine API 的接口，以下是部分已实现的接口列表：

API	实现程度
Issues	100%
Projects	100%
Project Memberships	100%
Users	0%
Time Entries	100%
News	100%
Issue Relations	100%
Versions	100%
Wiki Pages	100%
Queries	0%
Attachments	0%
Issue Statuses	100%
Trackers	100%
Enumerations	100%
Issue Categories	100%
Roles	100%
Groups	0%

4. 项目安装方式

项目的安装方式已在“安装指南”一节中进行了说明。简要回顾，使用 go get 命令即可完成安装：

go get github.com/mattn/go-redmine

通过本文档，用户应能掌握 go-redmine 的安装方法、基本使用方式以及 API 的调用方法。在遵循 MIT 许可的前提下，用户可以自由地使用和修改该项目。