https://github.com/dalion619/zeplin-dotnetcore
.NET Core REST client for https://zeplin.io/
https://github.com/dalion619/zeplin-dotnetcore
c-sharp dotnet-core rest-client zeplin
Last synced: about 2 months ago
JSON representation
.NET Core REST client for https://zeplin.io/
- Host: GitHub
- URL: https://github.com/dalion619/zeplin-dotnetcore
- Owner: dalion619
- License: mit
- Created: 2019-08-31T13:01:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-31T14:35:20.000Z (over 6 years ago)
- Last Synced: 2024-10-24T16:49:46.173Z (over 1 year ago)
- Topics: c-sharp, dotnet-core, rest-client, zeplin
- Language: C#
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zeplin.NetCore
.NET Core REST client for [zeplin.io](https://zeplin.io/). Unofficial and unsupported, Zeplin has no documented public API.
## Documentation
This client is built with [Refit](https://github.com/reactiveui/refit). The interfaces used interact with Zeplin's API endpoints can be found at [src/Zeplin.NetCore.RestClient/Interfaces](https://github.com/dalion619/zeplin-dotnetcore/tree/master/src/Zeplin.NetCore.RestClient/Interfaces). This started as a proof of concept of gaining additional value for non-designers in the product team.
### Use cases
* Compiling a linear history of subtle design changes by comparing screen version snapshots using a tool like [Blink-Diff](https://github.com/yahoo/blink-diff
).
* Exporting notes to Excel with [EPPlus](https://github.com/JanKallman/EPPlus) for tracking open issues.
## Usage
Register and configure the service with the `AddZeplinRestClientService` extension method.
```c#
.AddZeplinRestClientService(options =>
{
options.username = "YourZeplinUsername";
options.password = "YourZeplinPassword";
})
```
Inject or resolve the client service.
```c#
var zeplinRestClient = serviceProvider.GetService();
```
Interact with the required endpoints.
```c#
var projectDetails = await zeplinRestClient.GetProjectDetailsById(projectId);
```
## Example
The `Zeplin.ScreenDumpExample` project has sample code showing how to download a snapshot for every version of a screen in a Zeplin project.