<-- Back

Automatically generate documentation for Consumed REST Services

Issue

In Mendix applications, REST services published within the app automatically generate OpenAPI documentation, which can be accessed externally. When the application consumes REST services from external, non‑Mendix systems, OpenAPI documentation is unavailable, creating gaps in visibility and maintainability. 

Environment

Studio Pro (all versions)

Cause

The Mendix Consumed REST Service document does not support generating documentation for consumed services. Instead, the feature is designed to import an existing OpenAPI specification, which is then used to automatically create the corresponding request definitions within the Consumed REST Service document.

Solution / Workaround

The user should import an OpenAPI documentation to generate all the requests in the Consumed REST Service document.
When no OpenAPI documentation is available for an external service, the platform cannot generate this information, requiring developers to define the necessary operations manually.

Internal information related

  • 268296
  • C0A044PPS/p1767084549344329

Additional information

Mendix documentation: REST Services

Have more questions? Submit a request

0 Comments

Article is closed for comments.

To provide feedback, please open a ticket here. Don't forget to include the article's URL along with the feedback you would like to provide.