https://github.com/diadoc/diadocsdk-csharp

Official Diadoc SDK for C#
https://github.com/diadoc/diadocsdk-csharp

api cake csharp diadocsdk-csharp nuget sdk

Last synced: 24 days ago
JSON representation

Official Diadoc SDK for C#

• Host: GitHub
• URL: https://github.com/diadoc/diadocsdk-csharp
• Owner: diadoc
• License: mit
• Created: 2016-05-23T05:30:43.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-11T13:24:59.000Z (about 1 year ago)
• Last Synced: 2024-04-12T16:24:32.580Z (about 1 year ago)
• Topics: api, cake, csharp, diadocsdk-csharp, nuget, sdk
• Language: C#
• Homepage:
• Size: 1.61 MB
• Stars: 33
• Watchers: 21
• Forks: 61
• Open Issues: 121
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
|              | Build Status

|--------------|:--------------:

| master       | ![Build status (master)](https://github.com/diadoc/diadocsdk-csharp/actions/workflows/actions.yml/badge.svg?branch=master)

| latest       | ![Build status (lastest)](https://github.com/diadoc/diadocsdk-csharp/actions/workflows/actions.yml/badge.svg)

| nuget        | [![diadocsdk](https://buildstats.info/nuget/diadocsdk)](https://www.nuget.org/packages/diadocsdk/)

# diadocsdk-csharp

diadocsdk-csharp является официальной C#-реализацией клиента, использующего [публичный API Диадока](http://api-docs.diadoc.ru/).

Для подключения diadocsdk-csharp к вашему проекту рекомендуется использовать [nuget-пакет diadocsdk](https://www.nuget.org/packages/DiadocSDK/). Также можно скачать готовую сборку diadocsdk [со страницы релизов](https://github.com/diadoc/diadocsdk-csharp/releases).

## Документация

Документация последней версии SDK доступна по ссылке: http://api-docs.diadoc.ru/.

Мы планируем освежить документацию. Если у вас после её прочтения остаются вопросы, пожалуйста, выскажитесь в соответствующей [issue](https://github.com/diadoc/diadocsdk-csharp/issues/454).

## Примеры использования

[Diadoc.Samples](https://github.com/diadoc/diadocsdk-csharp/tree/master/Samples/Diadoc.Samples) — примеры кода работы API с пояснениями.

[Diadoc.Console](https://github.com/diadoc/diadocsdk-csharp/tree/master/Samples/Diadoc.Console) — пример консольного приложения, с помощью которого можно получать и отправлять документы, читать события, устанавливать связи с контрагентами.

## Сборка проекта

Для окончательной сборки проекта используется утилита [Cake](http://cakebuild.net/).

Запуск powershell-скрипта `build.ps1` скачает утилиту Cake, если ее у вас нет, и запустит сборку проекта.

Из командной строки этот скрипт можно запустить с помощью `generate.bat`.

Выполняется:

- генерация версии на основе тега github

- генерация C#-кода из proto-файлов

- ILMerge (сборка protobuf-net включается в DiadocApi)

- подписание сборки строгим именем (при наличии ключа diadoc.snk в папке src)

- создание nuget-пакета

## Добавление функциональности

- [Сделайте Fork](https://guides.github.com/activities/forking/)

- Создайте ветку для новой фичи (git checkout -b my-new-feature)

- Сделайте Commit изменений (git commit -am 'Add some feature')

- Сделайте Push новой ветки (git push origin my-new-feature)

- Создайте новый Pull Request