DOCSEARCHbyAlgolia
Submit Docs

Sysl System Modelling Language

website·Indexed 31 days ago

https://sysl.io/docs/

A system modelling language and toolkit designed to capture information about large-scale software systems. Sysl provides a single source of truth to generate code (including Go applications), data models, and visualisations such as sequence, integration, and data diagrams using PlantUML and Mermaid. It includes a CLI tool for importing schemas (e.g., Google Cloud Spanner), code generation, and an interactive REPL.

Tokens
25.1K
Snippets
151
Records
224
Agent score
60%

What's inside Sysl

  1. Overview of sysl-catalog

    sysl-catalog is a generator that converts Sysl specifications into Markdown, HTML, and diagrams. Its primary goal is to provide a seamless and standardized experience for engineers to document API behavior, allowing multiple teams to maintain consistent documentation and leverage existing documentation assets.

  2. Overview of the Sysl system specification language

    Sysl (pronounced "sizzle") is a system specification language used to define systems, endpoints, endpoint behavior, data models, and data transformations. The Sysl compiler uses a single common specification to automatically generate sequence diagrams, integrations, and various code generation outputs. The platform is designed for extensibility, allowing users to create their own custom output extensions.

  3. Overview of Sysl capabilities

    Sysl (pronounced “sizzle”) is a tool designed to synchronize system design, implementation, and testing work. It is used to generate diagrams, data schemas, Go code, and data transformations. The platform is open-ended, allowing users to create their own custom extensions for additional outputs.

  4. Overview of Sysl system specification language

    Sysl is an open-source system specification language used to model distributed web applications. It acts as a single source of truth for project or organizational design. Sysl can be used to generate various artifacts, including API documentation, data/integration/sequence design diagrams, SQL scripts for database creation and migration, and boilerplate REST/gRPC client/server code in Go.

  5. Overview of the Sysl specification language

    Sysl is a lenient specification language used to capture and describe the state of large-scale software systems, including their services, databases, and other assets. It is designed to be evolutionary, allowing developers to specify a high-level design or detailed current state, and to refine those specifications as decisions are made over time.

  6. Overview of sysl-catalog

    sysl-catalog is a static site generator designed to document API behavior and service interactions. It parses files with the .sysl extension (written in the Sysl system specification language) and generates visual representations, including sequence diagrams for endpoints, request/response types, database tables, and integration diagrams. It aims to prevent documentation drift by using a high-level specification as an intermediary between code and documentation.

  7. Overview of Sysl and its Tooling Ecosystem

    Sysl is a language designed specifically for capturing information about software systems. Its functionality is extended through an ecosystem of tools, most notably the sysl CLI, which process and interact with Sysl specifications.

  8. Overview of Sysl system specification language

    Sysl is a specification language designed to serve as a single source of truth for system design. It allows developers to generate design diagrams, code, documentation, and tests from a unified specification, ensuring that all artifacts remain consistent and version-aligned to prevent stale designs. It features an open-ended architecture capable of generating code for any programming language, with native out-of-the-box support for Go.

  9. Generate documentation using sysl-catalog CLI

    sysl-catalog is a standalone CLI tool used to generate documentation from Sysl specifications. It supports Markdown and HTML (via GoldMark) output formats.

  10. Generate high-quality code and documentation with Sysl

    Sysl allows for the generation of code, diagrams, and documentation that adhere to specific style guides and best practices, enabling security to be embedded into the system from the start.

  11. Generate Go applications with Sysl

    Sysl provides out-of-the-box code generation for Go applications, supporting the creation of both client and server implementations for REST and gRPC protocols.

  12. Define metadata using Sysl Annotations

    Annotations in Sysl associate a key-value pair of metadata with a model element. The key must always be a string. The value can be a string or an array of strings (either one-dimensional or two-dimensional). Annotations serve as extension points to capture domain-specific or organizational information.