Requirements Overview

Consumers/Developers first discovers API and then script/code to use API in their workflow. Producers/Developers of API need a place to post their APIs for discovery. API Portal aims to streamline this process. It bridges the gap between API producers and API consumers. API Developer portal consists of following core units

1. API Catalogue

   An API Catalogue describes what APIs are available for consumption, listing them all and providing ample descriptions for every method. Documentation should also provide the authentication and authorization mechanism, use cases that describe potential business contexts, and live real world implementations when possible.
   

2. API Life-cycle Management

   An API Portal should describe the API life cycle information. At the high level API Life cycle consists of following stages
   
   

3. Legal

   API Portal should define the terms and conditions to qualify as API consumer. It could be as simple as creating a user account and receiving API Keys. 

4. Training Resources

   API consumer provides documentations in following areas
   1. Onboarding new users
   2. How to consume API
   3. Sample Request and response
   4. Error Scenarios
   5. How to obtain security tokens

5. API Health Insights

   API portal should provide realtime API monitoring and API performance statistics. Consumer should receive API heartbeat to monitor API in realtime along-with other statistics like API usage, number of subscribers, average response time, etc.