API Connect

API Connect

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.

 View Only
Expand all | Collapse all

Number of APIS in Product Recommendation

  • 1.  Number of APIS in Product Recommendation

    Posted Tue August 30, 2022 11:53 AM
    could you please suggest that number of APIS in product and number of operations in API as it will impact product deployment .. do we have any recommendation or documentation regarding it.

    ------------------------------
    santhoshkumar surisetty
    ------------------------------


  • 2.  RE: Number of APIS in Product Recommendation

    Posted Mon September 05, 2022 10:35 AM
    Hiya,
    I'm afraid the answer is the old classic "it depends"!

    There is no hard limit on the number of APIs you can have in a product. I've seen occasions when there are 10s if not 100s. But there can be unexpected side effects - such as how would a consumer using the Developer Portal find the right API to use if they are presented with a flat list of 100 APIs in a product?

    A Product exists in order to group together related and similar APIs that the consumer is likely to want to use together. It allows for rate limits to be placed across them and for access control (visibility). It would depend on your specific use case how many APIs in a product makes sense.

    It's very similar when it comes to the number of operations in an API. You can certainly have 100s of individual operations in a single API. That does lead to a very large openapi document though, so again it can have consumability and user experience side effects in allowing customers to find the right operation they want within that API. Its not insurmountable though, obviously you can group by path, but you can also use concepts like tags to link together similar operations to make it easier to find the right one. 
    There does come a time when the API document is too big to be practical though - if your openapi document is starting to be around the 5Mb mark then I think you've cleared the upper bound of whats "reasonable". You will start seeing performance issues just rendering the API as the browser needs to download, parse and then render such a large document. API publishes will take longer as the API size increases too (though that time will still only be in seconds so might not really be noticeable).

    Hope that helps,

    Chris

    ------------------------------
    Chris Dudley
    ------------------------------