> For the complete documentation index, see [llms.txt](https://jen-hsuan-hsieh.gitbook.io/asp-net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jen-hsuan-hsieh.gitbook.io/asp-net/chapter3rest-api-design-development-and-management/35api-management/353api-developer-portal.md).

# 3.6.3.API Developer Portal

* Developer Portal ![](/files/-M4M0YZrrdHKLbfng36n)
* API documentation
  * Mange in Swagger/ OAI
    * Use externalDocs URL to connect with external documentation
    * Try it feature
      * Allow the developer to try over API on the developer portal without needing to write code
      * 幫助開始者了解API是如何運作的
    * Provide code sample, provide sample data
    * Provide SDK
    * [Walmart](https://developer.walmartlabs.com/io-docs)
* Manual provisioning
  * May work for internal teams
  * It's not suggested that you use this kind of a process for public or partner APIs in self provisioning

    ![](/files/-M4M0YZtlqadw4GJQ5sM)
* Self provisioning
  * Self service + Auto approved suggested (if possible)

    ![](/files/-M4M0YZvjQORpWutFNWo)
* Provisioning practices
  * Clearly define the role, responsible for authorization to API
  * Setup the API access policies for you API
  * Define a criteria for Automatic versus manual provisioning
    * Sensitivity of data
    * Limited capacity in thebackend
    * Trust tiers system
  * If the API is for internal use only then do not publish on portal
  * [Twitter](https://developer.twitter.com/)
* API management platforms
  * [ibm api management](https://www.ibm.com/support/knowledgecenter/zh-tw/SSWHYP_3.0.0/com.ibm.apimgmt.overview.doc/api_management_overview.html)
  * [apigee](https://apigee.com/api-management/#/homepage), [mashery](https://www.mashery.com/)
  * [mulesoft](https://www.mulesoft.com/cn/)
* Support
  * Internal only, Public, Monetized
  * Guidance on how solve some common problems (FAQ)
  * Provide best practices
  * Contact forms
  * Bug reporting
  * Build a developer community
    * Social media, blog, forum
* Build v.s. Buy
  * Developer portal is a web applicaton
  * Build option
    * Documentation from swagger/ OAI may be publish as-is
    * For self service provisoning a work flow will need to be designed 
  * Buy option
    * API product vendors offer Developer Portal bunled with their products
    * Support look and feel customization
    * Some have provision to extend the portals