net-gitee

net-gitee — это .Net SDK для Gitee OpenAPI.

• Gitee API адрес (Developer): https://gitee.com/api/v5/swagger.
• Gitee API адрес (Enterprise): https://gitee.com/api/v8/swagger.

Реализация функций

1. Socket.
2. CodeGen.
3. Модель перемещения (в процессе).
4. Полное использование документации.
5. Примеры веб-вызовов.
6. Подробное описание документации.
7. Модель Webhook.
8. Проверка подписи Webhook.
9. Вызов API.
10. Дизайн авторизации.
11. Дизайн модели.
12. Дизайн фреймворка.

Архитектура программного обеспечения

— CodeGen (генератор кода, в настоящее время в основном генерирует модель запроса).
— Template (шаблон).
— Class.
— Property.
— GiteeApiV5.json (файл SwaggerJson Gitee: вход).
— GiteeApiV8.json (файл SwaggerJson Gitee: вход).
— Swagger-V2 Model.

— Console (программа командной строки, в основном используется для тестирования некоторых интерфейсов и реализации).

— GiteeOpenSdk (основная программа).
— Common (используемый набор инструментов).
— Models (модель API, импортированная из CodeGen, не рекомендуется изменять, используйте partial для расширения).
— Base (повторно используемая часть модели).
— Request (модель запроса).
— Response (модель ответа).
— Другое (базовая модель и модель авторизации).
— Services (основные услуги).
— WebHook (поддержка WebHook).
— Models (модель крючка).
— SignVerification (проверка подписи).

— Sample (пример кода для практики в Интернете) (ожидается обновление).
— Пример вызова Sdk.
— Пример WebHook.

— SwaggerCodegen (автоматически сгенерированный .Net Core SDK с использованием SwaggerCodegen).

Лучшие практики (будут постепенно открыты)

— Автоматическое создание ветки при запуске задачи и связывание (уже реализовано, будет открыто после доработки).
— Анализ WebHook(issue_state_change).
— Запрос на ветку.
— Создание ветки.
— Связывание задач с веткой.

— Автоматическая генерация PR при проверке задачи (планируется).
— Закрытие связанной задачи при проверке PR (сейчас необходимо вручную ввести #IssueID в содержании PR, чтобы связать задачу) (планируется).
— Напоминание о вехе и напоминание о просроченной задаче (опрос).

Руководство по установке (ожидает обновления)

Инструкция по использованию (ожидает обновления)

Примечание

— Используйте partial, чтобы расширить модель.
— Именование модели основано на поле operationId файла swagger.json.

🥗 Требования к среде

— Visual Studio 2019 16.8 + (или версия для Mac).
— .NET 5 SDK +.
— Стандарт .Net 2.1 + (ожидает обновления).

🍻 Вклад кода

Проект net-gitee следует лицензии Apache-2.0 и приветствует всех, кто вносит свой вклад в проект через PR или Issue.

Если вы хотите внести свой вклад, пожалуйста, ознакомьтесь с руководством по внесению вклада.