Question

IFS Cloud 22R2 - API Explorer Documentation

  • 3 July 2023
  • 3 replies
  • 105 views
G
Rank
Userlevel 3
Badge +9

Hi All,

Currently it is not possible to publish API Explorer documentation in internal customer documentation locations. For example ‘Confluence’.
Customer does not like to login to IFS Environments and check API documentation but would like to publish API Documentation related to their business processes with their internal design documents in their own locations so that they can keep everything in one place.
Are there any plans to build this so that customers will be able to Copy/Publish API Documentation related to Core/Cust REST APIs inside third party documentation tools.

3 replies

ashdlk
Rank
Userlevel 3
Badge +5

@GaSoGB This is something being discussed at R&D level to make the documentation independent from the client. We are still in the planning stage for this. For the moment though, you can download (copy,paste) the openAPI specification for a given API from the API Explorer and save it in any location. The openAPI specification is a standard so it can be opened from any standard tool like Swagger. Downside is you need to take an updated copy after each update or any customization. 

Ashan
Rifki Razick
Rank
Userlevel 4
Badge +9

Hi @GaSoGB 

There are no plans at the moment to enable customers to copy the documentation and place it on their own servers. One of the advantages of having the API documentation in the application is that it is dynamic in nature. For example when configurations are made to the APIs (e.g. custom fields) or new custom APIs  are developed the API documentation will automatically pick this up. This will not be possible when the documentation is copied and placed in another location as static files.

However if this is not an issue, one option would be for customers to download the OpenAPI v3 specifications for all relevant APIs and then publish them using a 3rd party documentation tool (Redoc, Swagger etc.) hosted in their own server to visualize the API docs.

Rifki
G
Rank
Userlevel 3
Badge +9

Thanks @ashdlk and @Rifki Razick ,

I will suggest customer to get the specification and publish them in Swagger. This customer has some custom APIs being developed so changes will be rare after go live.
From IFS perspective, we know that using API explorer documentation will give you latest update but customer does not like our pitching unfortunately.
They have their own detailed documentation for their complex integration designs with various third party systems and they prefer to have IFS API Documentation also in the same place instead of login into IFS Applications. 
Giving an option to publish directly is great but for the time being, we can suggest them to get the specification and then publish it in their own documentation tools.

Best regards
Gayan S

Reply


Terms & ConditionsCookie settings