Skip to content

Override API overview page per api

It's possible to display a custom Overview content for any API by adding a document by following the steps given bellow.

  1. Login to API Publisher go to documents tab of the API you want to override.

  2. Create a new document with the following settings. ../../../../../assets/img/Learn/override-api-overview-page-per-api-publisher1.png

    Input Name Input Value
    Name Custom Overview
    Summary summary about the overview page for financeAPI1
    Type Other
    Other Document Type _overview
    Source Markdown
  3. Click the save button and from the dialog box select ADD CONTENT

  4. Add markdown content.

    Following keys can be use within the markdown to get some of the API properties.

    Property Name Key to use in markdown
    name name
    authorizationHeader authorizationHeader
    avgRating avgRating
    context context
    id id
    lifeCycleStatus lifeCycleStatus
    provider provider
    type type
    version version

    ../../../../../assets/img/Learn/override-api-overview-page-per-api-publisher2.png

Above screen demonstrate the use of name key to display API name within the markdown content.

Overview for the selected API will be rendered from the markdown content in the devportal.

../../../../../assets/img/Learn/override-api-overview-page-per-api-devportal.png

Top