IRIS API EXPLORERIRIS API EXPLORER
Watch
0
Star
0
Category
Developer Environment
Works with
Tags
Version
1.0.0
Last updated
2019-05-21
Repository
License
Download
Discuss
Details
Version history
Issues
Discuss

What's new in this version

First version

IRIS API Explorer is an Angular Application that make use of the InterSystems IRIS REST API discovery and API generation (IRIS version 2019.1). With this App you can easily (a visually) query for the existing API implemented in IRIS, create or update new APIs using a Swagger 2.0 OAS specification and also extract the auto-generated Swagger from an existing API

IRIS Explorer

This App demo the InterSystems IRIS REST API discovery and API generation (InterSystems IRIS version 2019.1). There is a nice article explaining the background at InterSystems Developer Community: https://community.intersystems.com/post/iris-api-explorer-application

Docker

In order to run this app easier I prepared a Docker container for a quick start

Pre-requisites

  • You need a valid license for IRIS. Put it in ./shared folder

Docker Compose

The project come ready to run on Docker. You have only to execute:

docker-compose up -d

This command starts two docker compose services:

  • iris-explorer_web [the angular app deployed in a NGIX web server]
  • iris-exploreer_iris [iris 2019.1]

When you have everything up you need to start session in IRIS http://localhost:55773/csp/sys/%CSP.Portal.Home.zen and change the login password. Once you change the password you can access to the Angular app http://localhost/home and start exploring IRIS APIs using the user and password you used before

When you finish your demo then execute:

docker-compose down

and everything stop smooth

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

The application support i18n translations in order to run with another language run:

ng serve --aot --i18nFile=src/locale/messages.es.xlf --i18nFormat=xlf --locale=es

More help about how to configure i18n here [https://v5.angular.io/guide/i18n]

Code scaffolding

This project was generated with Angular CLI version 7.1.3 Using Angular 5.2.2

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

Email me :-) or add a Github issue