Home Applications iris-web-swagger-ui

iris-web-swagger-ui

This application is not supported by InterSystems Corporation. Please be notified that you use it at your own risk.
4.67
3 reviews
0
Awards
1.2k
Views
1.8k
IPM installs
1
7
Details
Releases
Reviews
Issues
Pull requests
Dependants
Interactive Swagger docs for your REST API

What's new in this version

Initial Release

IRIS Swagger UI

Quality Gate Status

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

Made with
Install
zpm install swagger-ui download archive
Version
1.0.012 Apr, 2020
Category
Developer Environment
Works with
CachéInterSystems IRIS
First published
12 Apr, 2020
Last checked by moderator
15 Jan, 2024Works