README.md

SAMT - Simple API Modeling Toolkit

Tired of unreadable OpenAPI YAML files and a plethora of different tools?
SAMT is a developer-focused, extensible and easy-to-learn toolkit for modeling APIs using a business-first approach

---

Documentation

Get started with SAMT, learn fundamental concepts or extend SAMT with a custom generator.

• Getting Started
• Modeling Concepts
• SAMT Template
• Visual Studio Code Plugin
• API Documentation

Advanced

• Authoring Generators
• Architecture

Development Setup

SAMT is written in Kotlin and uses Gradle as a build tool, for the best developer experience we recommend using IntelliJ IDEA.

If you want to start SAMT locally, simply clone the repository and compile it using Gradle:

./gradlew assemble

And then use this locally compiled SAMT to compile your SAMT files:

java -jar ./cli/build/libs/samt-cli.jar compile ./specification/examples/samt.yaml

If you are interested in learning about the functionality and operation of the SAMT Visual Studio Code Plugin or methods for running and debugging the related language server on your local machine, related documentation is available in the SAMT VS Code Wiki.

Contributing

Want to report a bug, contribute code, or improve documentation? Excellent! Simply create an issue, open a pull request or start a discussion.