View on GitHub

Microservice DSL (MDSL)

A Domain-Specific Language (DSL) to specify (micro-)service contracts, their data representations and API endpoints.

Quick Links: MDSL Home, OpenAPI, Protocol Buffers, GraphQL schema, Jolie, Java POJOs, Freemarker, AsyncAPI

MDSL Tools: Users Guide

At present, two types of MDSL tools are available here:

Context Mapper has its own website.

Command Line Interface (CLI) Tools

The CLI tools can validate MDSL files and call our generators from the command line. When calling ./mdsl (or mdsl.bat in Windows), the CLI shows you the available parameters:

usage: mdsl
 -f,--outputFile <arg>   The name of the file that shall be generated.
                         This parameter is only used if you pass 'text' to
                         the 'generator' (-g) parameter because the
                         Freemarker generator does not guess any file name
                         extension).
 -g,--generator <arg>    The generator you want to call. Use one of the
                         following values: oas (OpenAPI Specification),
                         jolie (Jolie), text (arbitrary text file by using
                         a Freemarker template), proto (Protocol Buffers),
                         graphql (GraphQL Schemas), java (Java Modulith),
                         gen-model-json (Generator model as JSON
                         (exporter)), gen-model-yaml (Generator model as
                         YAML (exporter))
 -h,--help               Prints this message.
 -i,--input <arg>        Path to the MDSL file for which you want to
                         generate output.
 -o,--outputDir <arg>    The output directory into which the generated
                         files shall be written. By default files are
                         generated into the execution directory.
 -s,--standalone         Create output in main memory and write it to
                         standard output console.
 -t,--template <arg>     Path to the Freemarker template you want to use.
                         This parameter is only used if you pass 'text' to
                         the 'generator' (-g) parameter. 

Please refer to the readme of the DSL core project and of the CLI package for more information.

Eclipse Plugin

MDSL Editor

The MDSL Eclipse plugin provides editing support (syntax highlighting, auto completion, etc.) for our DSL. You can install the released snapshot versions of he plugin in your Eclipse from the following update site:

https://microservice-api-patterns.github.io/MDSL-Specification/updates/

Once you have installed the plugin successfully, the MDSL editor should open for any file that ends with .mdsl. You can create one and copy-paste the above hello world example, or find additional examples in this folder.

If you want to check whether the plugin has installed successfully, you can go to the Eclipse “Help” menu, select “About Eclipse IDE” and then “Installation Details”. Two MDSL entries should be there.

API Linter

The API Linter comes with the MDSL Editor as well as the CLI (see above); every time a file is saved or parsed, a number of validation rules and some simple metrics are evaluated and the results displayed in the Problems view of Eclipse.

In addition to the usual editor features such as syntax highlighting, completion and syntax checking, it implements a few simple semantic validators (as a basic API Linter demonstrator):

An example that features all validators in action can be found in the examples folder of the repository: APILinterTestAndDemo.mdsl. The validation of this MDSL file yields the following errors, warnings and information messages (among others): API Linter example

Transformations

Quick fixes and menu entries support rapid service-oriented analysis and design and an “API first” approach. For instance, the plugin now comes with quick fixes to complete data type specifications:

Many endpoint-level transformations are available now too, including one to create AsyncMDSL from core MDSL. A Move Operationrefactoring is available as a menu entry as well.

See this page for more information on the quick fixes and transformations.

Generators

In the MDSL Editor, you can invoke the following generators from the “MDSL” entry in the context menu:

These generator features are also available in the CLI (see above).

Generator Model for Freemarker Templating and Model Exports

To ease code generation with the template-based generator, we provide an intermediate model. The following class diagram illustrates it:

MDSL Generator Model

This model can also be exported for offline processing (for instance, to feed other tools):

Note: This feature is not yet complete, and the model API subject to change at any time. We do use it internally in the GraphQL schema and Java generators, so it has reached a certain level of maturity and test coverage. That said, it also has some known limitations; for instance, the output can be rather verbose and partially redundant (input depending, of course).

Site Navigation

HomeEndpoint TypeData TypeProvider and ClientBindingsTutorialTools

Copyright: Olaf Zimmermann, 2018-2021. All rights reserved. See license information.