Interoperability REST API Template

About

Features out-of-the-box:

• Adds online OpenAPI 2.0 specification (see /swagger endpoint) to your APIs
• Adds /healthcheck endpoint - a simple way to check API publication
• Metrics in OpenMetrics format are included
• Rate limits (requests per minute) can be set
• And main: adds to all your API common entry point in Interoperability (Production). That, in turn, allows you to use the best IRIS feature - visual traces!

Quick start

1. Implement the needed API using a specification-first way
2. Add to your .disp class routes /swagger and /healthcheck (see Sample.API.disp for example)
3. Add calls REST.Service.API to your .impl class (see example in Sample.API.impl)

Quit ##class(REST.Service.API).Call(body, $$$CurrentMethod, $CLASSNAME())

4. Add to Production REST.Service.API service
5. Create and add to Production handlers for the methods of your custom API. Set REST.Process.CallHandler as the parent class if you need correct links building in Production UI. You can find a sample of handler in the Sample.Process.TestPost class
6. Add routes for API methods to the RESTRoutes lookup table (sample RESTRoutes.LUT)
7. Enjoy!