Skip to content

Usage Guide

Learn how to use the OpenAPI Client Generator to create Dyalog APL clients from OpenAPI specifications.

Basic Usage

Generating a Client

The basic command to generate a client:

dotnet run -- path/to/openapi.json ./output

Arguments: - path/to/openapi.json - Path to your OpenAPI specification file - ./output - Output directory for generated code (optional)

This will create a complete APL client in the ./output directory.

Using Generated Clients

Loading the Client

⍝ Load the generated client
]LINK.Import # ./APLSource

Making API Calls

⍝ Create a client instance
client ← ⎕NEW Client

⍝ Call an API method
result ← api.pet.findPetsByStatus.syncDetailed (client:client ⋄ status:'available')

⍝ Handle the response
:If result.statusCode≡200
    pets ← result.Data
    ⎕← 'Found ',⍕≢pets,' pets'
:Else
    ⎕← 'Error'
:EndIf

Command-Line Options

Input Options

  • OpenAPI Specification: Path to OpenAPI 3.0 JSON or YAML file
  • Output Directory: Where to generate the code (default: ./output)

Troubleshooting

TODO

Next Steps