openapi-server-gen

Downloads6
Subscribe
1
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
Dependencies
Dependants

What's new in this version

  • Add missing %JSON.Adaptor super class to generated models.

Gitter
Quality Gate Status
Reliability Rating

License: MIT

openapi-server-gen

This is a library to generate server-side REST classes for intersystems IRIS.
openapi-server-gen is piece of a bigger project openapi-suite ( OEX Link - GitHub ).

Installation zpm

zpm "install openapi-server-gen"

optional swagger-ui

zpm "install swagger-ui"

Installation docker

git clone git@github.com:lscalese/openapi-server-gen.git
cd openapi-server-gen
docker-compose up -d

Usage

Generate petstore server-side class from OpenAPI 3 specification

Open an IRIS terminal :

Set applicationName = "petstoresrv" ; this is the package name for the generated classes.  
Set webApplication = "/petstore/api" ; webapplication name to create, leave empty if you don't want create the web apps
Set sc = ##class(dc.openapi.server.ServerAppGenerator).Generate(applicationName, "https://petstore3.swagger.io/api/v3/openapi.json", webApplication)

Explorer generated class in petstoresrv package.

If you install swagger-ui you can open this page http://localhost:52797/swagger-ui/index.html and then explore http://localhost:52796/petstore/api/_spec

More information about this package will be available soon on OpenExchange.

IPM installation
zpm "install openapi-server-gen"
Rating
5 (1)
ObjectScript quality test
Passed
Updated on 27 September 2023
ObjectScript quality report
Category
Solutions
Works with
InterSystems IRIS
Tags
Info
Version
1.0.1
Last updated
2023-09-27
Repository
Open
Documentation
Open
License
Link