iris-web-swagger-ui


Follow
2
Star
3
Details
Screenshots
Version history
Issues
This application is not supported by InterSystems Corporation. Use it at your own risk.

What's new in this version

Initial Release

Interactive Swagger docs for your REST API

IRIS Swagger UI

It is a tool to generate interactive documentation for your REST API.

Install

The tool is available as a ZPM module. You can install the tool easy:

USER> zpm
ZPM: USER> install swagger-ui

Getting started in 3 steps

  1. Create REST API
  2. Provide Swagger Spec url for your REST API
  3. Open browser and go to SwaggerUI page (http://localhost:52773/swagger-ui/index.html) and enter your Swagger Spec url

Demo

swagger-ui

Contribute

Any contribution is welcome. To start you can clone the repository and up the project in Docker.

$ git clone https://github.com/atygaev/iris-web-swagger-ui.git
$ cd iris-web-swagger-ui
$ docker-compose up -d

For your convenience the project contains simple REST API (src/Sample/PersonREST.cls).

Swagger documentation for the REST API is available at http://localhost:52773/swagger-ui/index.html

ZPM installation
zpm "install swagger-ui"
Category
Developer Environment
Works with
CachéInterSystems IRIS
Tags
Info
Version
1.0.0
Last updated
2020-04-12
Repository
Open
Documentation
Open
License
Link