development-setup.md

Development Setup

Prerequisites

• .NET 10 SDK — required to build and run the generator (download)
• Dyalog APL v20.0 or later — needed to load and test the generated client output (download)
• Python 3 with MkDocs Material — needed to serve the docs locally (optional)

Clone the repository

git clone https://github.com/Dyalog/OpenAPI.git
cd OpenAPI

The docs/documentation-assets directory is a git submodule. Initialise it after cloning:

git submodule update --init

Build

dotnet build

Run from source

dotnet run --project src/OpenAPIDyalog -- <spec-file> [output-directory]

For example:

dotnet run --project src/OpenAPIDyalog -- petstore.yaml ./out

Run tests

dotnet test

Serve the docs locally

Install MkDocs Material if you haven't already:

pip install mkdocs-material

Then serve:

mkdocs serve

The docs will be available at http://127.0.0.1:8000.