openapi-suite-client

Downloads1
Subscribe
0
Bookmark
0
This application is not supported by InterSystems Corporation. Please be notified that you use it at your own responsibility.
Details
Releases
Reviews
Issues
Articles

What's new in this version

Initial Release

Gitter Quality Gate Status Reliability Rating

License: MIT

openapi-suite-client

This is a tiny http client for openapi-suite.

It's useful if you want to generate code from a remote openapi-suite installation and avoid install all code generation tools on your local instance.

Installation zpm

zpm "install openapi-suite-client"

Installation docker

Clone/git pull the repo into any local directory

git clone https://github.com/intersystems-community/openapi-suite-client.git

Open the terminal in this directory and call the command to build and run InterSystems IRIS in container:

docker-compose up -d

To open IRIS Terminal do:

docker-compose exec iris iris session iris -U IRISAPP

Usage

; remote openapi-suite rest service url : 
Set server = "https://openapisuite.demo.community.intersystems.com/openapisuite"

; Specification could be an URL, filepath or a stream.
Set specification = "https://petstore3.swagger.io/api/v3/openapi.json"

; Package name for generated classes.
Set packageName = "petstoreclient"

; available type :
; - "client" : to generate http client classes.
; - "production" : to generate production client classes.
; - "rest" : to generate REST server classes
Set type = "client"

Set sc = ##class(dc.openapi.suite.client.RemoteCodeGen).Generate(specification, packageName, type, server)

More information about open-suite are available on this DC article.

IPM installation
zpm "install openapi-suite-client"
Rating
5 (1)
ObjectScript quality test
Passed
Updated on 24 September 2023
ObjectScript quality report
Category
Solutions
Works with
InterSystems IRIS
Tags
Info
Version
1.0.0
Last updated
2023-02-06
Repository
Open
Documentation
Open
License
Link