Developer Portal para APIs IRIS com Redoc

Redoc é uma solução de código aberto capaz de renderizar especificações de API em OpenAPI 2.0 ou 3.0+ como portais web muito bonitos e funcionais. Atualmente, para ter algo semelhante, precisamos da extensão ZPM SwaggerUI ou instalar o IAM (InterSystems API Manager) e configurar o Portal do Desenvolvedor do IAM. Agora, a comunidade tem mais uma opção: iris-redoc. Essa solução instala um aplicativo web na sua instância IRIS que usa o Redoc para apresentar um portal web elegante para suas APIs REST.

Como instalar e usar
 

Acesse https://openexchange.intersystems.com/package/iris-redoc.

É muito fácil de instalar e usar. Existem duas possibilidades:

Adicione a dependência ao seu arquivo module.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Export generator="Cache" version="25">
 <Document name="rest-api-template.ZPM">
   <Module>
     <Name>rest-api-template</Name>
     <Version>1.1.0</Version>
     <Packaging>module</Packaging>
     <SourcesRoot>src</SourcesRoot>
     <Resource Name="dc.Sample.PKG"/>
     <Dependencies>
       <ModuleReference>
         <Name>iris-redoc</Name>
         <Version>1.0.0</Version>
       </ModuleReference>
     </Dependencies>
      <CSPApplication
       Url="/crud"
       DispatchClass="dc.Sample.PersonREST"
       MatchRoles=":{$dbrole}"
       PasswordAuthEnabled="1"
       UnauthenticatedEnabled="1"
       Recurse="1"
       UseCookies="2"
       CookiePath="/crud"
      />
   </Module>
  
 </Document>
</Export>

A segunda opção é acessar o terminal da sua instância do IRIS e executar o comando:

zpm install iris-redoc

Depois de instalar, é muito simples!

Acesse http://[host]:[port]/csp/redoc/?url=[url of the swagger/openapi.json] no seu navegador.
 

Exemplo 1 (external public open api - github API sample): http://localhost:52773/csp/redoc/?url=https://raw.githubusercontent.com…
Exemplo 2 (sua IRIS API):
http://localhost:52773/csp/redoc/?url=http://localhost:52773/crud/_spec

Agora é navegar e aproveitar o Redoc.