Giter Club home page Giter Club logo

yuml-client's Introduction

Welcome to Yuml client

Introduction

This repository contains a small .Net client to communicate with the popular online UML diagram service yuml.me.

This service allows to easily generate relationship diagrams based on provided UML input.

More on this can be found on its website (https://yuml.me).

The purpose of the client is to hide HTTP details from the calling code, and thus greatly simplify creating UML relationship diagrams programatically.

How to use it

Here is some basic example:

IYumlClientService clientService = new YumlClientService();

string[] umlStrings =
{
   "[Customer|->[Order]",
   "[Customer] ->[Address]",
   "[Order]->[Stock]"
};

DiagramFile diagramFile = await clientService.BuildDiagram(umlStrings, FileFormat.Svg);

Example result:

{
  "FileName": "12345.svg",
  "ContentType": "image/svg+xml",
  "Content": "{here is binary content of generated svg file}"
}

Here is more advanced example with background color, class methods, and text note:

string[] umlStrings =
{
   "[Customer|-forname:string;-surname:string|doShiz()]<>-orders*>[Order]",
   "[Order] -0..*>[LineItem{bg:red}]",
   "[Order]-[note:Aggregate Root ala DDD{bg:wheat}]"
};

DiagramFile diagramFile = await clientService.BuildDiagram(umlStrings, FileFormat.Svg);

yuml-client's People

Contributors

mtchesnokov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.