On this page:

5.5OpenAPI / Swagger Support

 

All Smile CDR FHIR Endpoint modules (FHIR Endpoint, FHIR Gateway, Hybrid Providers) support automatic generation of OpenAPI (aka Swagger) documentation. This documentation describes the FHIR operations, parameters, anbd request/response details supported by the API.

This support can be enabled and disabled by setting the Enable OpenAPI / Swagger Support setting on the appropriate FHIR Endpoint module.

With this setting enabled, you may wish to set the other Capability Statement Settings as well, as these will control the information exported by the OpenAPI document.

5.5.1Swagger UI

 

One of the primary uses for OpenAPI documentation is to power the Swagger UI tool.

When OpenAPI support is enabled on a Smile CDR FHIR Endpoint, a customized version of Swagger UI will be automatically served by the FHIR Endpint at: [baseUrl]/swagger-ui/.

5.5.2Limitations

 

Smile CDR support for OpenAPI has the following known limitations:

  • Complete schema definitions are not yet supplied for FHIR Resources.

  • The customized Swagger UI does not yet support OpenID Connect authentication, meaning that it can be used to execute operations on a SMART on FHIR endpoint. Note that despite this limitation, Swagger UI can still be used to examine the API and discover operations, so there is still value in enabling it on SMART on FHIR endpoints.