Kroki

API جاوا منبع باز برای ایجاد نمودارها از متن

کتابخانه رایگان جاوا که توسعه دهندگان نرم افزار را قادر می سازد تا نمودارهایی را از توضیحات متنی ایجاد کنند. از بلوک دیاگرام، نمودار توالی، نمودار فعالیت، نمودار شبکه و موارد دیگر پشتیبانی می کند.

Kroki یک Java API یکپارچه دارای مجوز MIT است که به توسعه دهندگان نرم افزار امکان می دهد نمودار را از توضیحات متنی در برنامه های جاوا خود ایجاد کنند. این یک API یکپارچه بسیار پایدار برای تمام کتابخانه های نمودار است که می تواند در هر جایی استفاده شود. این کتابخانه از معماری ماژولار پیروی می کند و ماژول های مختلفی مانند وب سرور جاوا به عنوان دروازه، Umlet Java API برای تولید نمودارها، Node.js CLI و موارد دیگر را ارائه کرده است.

این کتابخانه از چندین نوع نمودار مهم مانند بلوک دیاگرام، BPMN، Bytefield، نمودار توالی، نمودار فعالیت، نمودار شبکه، نمودار بسته، RackDiag، C4 (با PlantUML)، Ditaa، Erd، GraphViz، Mermaid، پشتیبانی کرده است. Nomnoml، PlantUML، SvgBob، UMLet، WaveDrom و بسیاری دیگر. این کتابخانه را می توان به فرمت های زیر PNG، SVG، JPEG، PDF، Base64 و موارد دیگر صادر کرد.

کتابخانه عملکرد و سرعت فوق العاده ای ارائه می دهد. شما به راحتی می توانید با استفاده از هر سرویس گیرنده HTTP با کتابخانه تعامل داشته باشید. این یک API HTTP برای ایجاد نمودار از توضیحات متنی ارائه می دهد و می تواند هر دو درخواست GET و POST را مدیریت کند. این برنامه از تسهیلات رمزگذاری نمودار پشتیبانی می کند و به کاربران اجازه می دهد از الگوریتم deflate + base64 با درخواست GET استفاده کنند.

در یک نگاه

مروری از ویژگی‌های Kroki.

بررسی اجمالی ویژگی ها

ایجاد نمودار
متن به نمودار
خواندن نمودار
نمودار توالی
بلوک دیاگرام
نمودار فعالیت
نمودار کلاس

Kroki

Kroki از قالب‌های فایل Microsoft Visio که در زیر فهرست شده‌اند، پشتیبانی می‌کند.

فقط خواننده

فقط نویسنده

Kroki

استقلال پلتفرم

Kroki فقط به زمان اجرای جاوا نیاز دارد.

Java

Kroki

شروع به کار با کروکی

روش توصیه شده برای نصب Kroki استفاده از Docker است. لطفا از دستور زیر برای نصب راحت استفاده کنید.

Kroki را با استفاده از Docker نصب کنید

docker run yuzutech/kroki

Clone Kroki git Repository

git clone https://github.com/yuzutech/kroki.git

ایجاد بلوک نمودار از طریق Java API

یک دیاگرام بلوکی یک نمودار جریان بسیار تخصصی و سطح بالا را نشان می‌دهد که در مهندسی استفاده می‌شود، که بخش‌ها یا عملکردهای اصلی را نشان می‌دهد که توسط بلوک‌ها نشان داده می‌شوند و به هم پیوسته با خطوط ارتباط بلوک‌ها را نشان می‌دهد. کتابخانه منبع باز Kroki به توسعه دهندگان نرم افزار اجازه می دهد تا با استفاده از دستورات جاوا، بلوک دیاگرام را در داخل برنامه های خود ایجاد کنند. همچنین می توانید به راحتی نمودار موجود را تغییر دهید.

ایجاد بلوک دیاگرام جدید از طریق جاوا

blockdiag {
  blockdiag -> generates -> "block-diagrams";
  blockdiag -> is -> "very easy!";

  blockdiag [color = "greenyellow"];
  "block-diagrams" [color = "pink"];
  "very easy!" [color = "orange"];
}

ایجاد نمودار توالی

کتابخانه منبع باز جاوا Kroki به توسعه دهندگان نرم افزار اجازه می دهد تا نمودارهای توالی را در برنامه های خود ایجاد و مدیریت کنند. کتابخانه اجازه می دهد تا به راحتی عناصر جدید را در یک نمودار اضافه کنید و به طور خودکار عناصر ایجاد شده را مرتب کنید. این کتابخانه به راحتی جریان فعالیت‌ها را کنترل می‌کند و به کاربران این امکان را می‌دهد که به راحتی عناوین فعالیت‌ها را وارد یا به‌روزرسانی کنند، یک فعالیت را حذف کنند، فعالیت‌ها را دوباره مرتب کنند و موارد دیگر

ایجاد نمودار توالی جدید از طریق Java API

seqdiag {
  browser  -> webserver [label = "GET /index.html"];
  browser <-- webserver;
  browser  -> webserver [label = "POST /blog/comment"];
  webserver  -> database [label = "INSERT comment"];
  webserver <-- database;
  browser <-- webserver;
}

صادر کردن نمودار به SVG یا PDF از طریق جاوا

کتابخانه Kroki به توسعه دهندگان نرم افزار این امکان را می دهد که انواع مختلفی از نمودارها را در برنامه های جاوا خود ایجاد کنند. این کتابخانه عملکرد و سرعت بسیار خوبی را در هنگام ایجاد نمودار ارائه می دهد. پس از ایجاد می توانید آن را به چندین فرمت فایل پشتیبانی شده مانند PNG، SVG، PDF، JPEG و بسیاری دیگر صادر کنید. می توانید فرمت خروجی را با استفاده از هدر Accept مشخص کنید یا می توانید فرمت خروجی را در URL نیز تعریف کنید.