Skip to main content
Open

Data Virtualization: Link to API Specification available on API Docs page

Related products:FME Flow
  • August 30, 2025
  • 8 replies
  • 65 views

itay
Supporter
Forum|alt.badge.img+18

Hi,

Wouldn’t it be great if FME could automatically generate a link to your API docs, just like the FME Flow API does?

 

This would make the APIs you create almost self-documenting and ensure compliance with the Dutch national API guidelines.

8 replies

rylanatsafe
Safer
Forum|alt.badge.img+14
  • Safer
  • September 2, 2025

Hi ​@itay , to help me understand your request—are you referring to an API external to FME?

If so, could you share more details about how you envision the configuration steps? A rough outline or example would really help clarify the use case.

In addition to the Flow REST API you mentioned, it's also worth noting that if you create any Data Virtualization APIs in FME, the corresponding Swagger API documentation is automatically generated for you.


alexbiz
Influencer
Forum|alt.badge.img+30
  • Influencer
  • September 2, 2025

Hey ​@rylanatsafe,

I think he is talking about an equivalent of http://<fmeflowweburl>/fmeapiv4/v3/api-docs but for Data Virtualization API.
As of FME 2025.1 b25606, FME Flow doesn’t generate any API documentation endpoint, or doesn’t show it :

It would be good to have something like http://<fmeflowweburl>/api/<apiname>/api-docs


rylanatsafe
Safer
Forum|alt.badge.img+14
  • Safer
  • September 2, 2025

Thank you, ​@alexbiz ! That helps to clear it up.

It’s possible to obtain, but only through the Flow UI (Actions > Export OpenAPI Specification) which doesn’t make it easy for external clients or users...


alexbiz
Influencer
Forum|alt.badge.img+30
  • Influencer
  • September 2, 2025

Oh, I hadn't realized that was possible, nor what was under the Action menu. It's easy to miss.
So there's an endpoint for this, but it's only requestable from the UI? Would it be possible to integrate it into FME Flow's Rest API?


itay
Supporter
Forum|alt.badge.img+18
  • Author
  • Supporter
  • September 3, 2025

@alexbiz you are correct I am referring to the OpenAPI document.

@rylanatsafe I know that is it possible to export it, but as you say it is not easy to share with external users and it would be much better to have is as an integral part of the swagger documentation.

Hope this makes sense.


alexbiz
Influencer
Forum|alt.badge.img+30
  • Influencer
  • September 3, 2025

Yes it would make sense to have a public endpoint to get that, easy to reach from the WebUI documentation.


rylanatsafe
Safer
Forum|alt.badge.img+14
  • Safer
  • September 4, 2025

@itay ​@alexbiz after a short chat with the development team, we can investigate inserting a link to export/view directly form the API docs page.

For reference, the current URL we have in the Flow REST API to support this is

https://hostname/fmeapiv4/datavirtualization/{id}/export

 

Thanks again for the clarifications regarding this idea!


rylanatsafe
Safer
Forum|alt.badge.img+14
  • Safer
  • September 15, 2025
NewOpen