home

Heretto Deploy Portal

Heretto CCMSHeretto Deploy PortalHeretto Deploy API
Heretto CCMSHeretto Deploy PortalHeretto Deploy API

Show Contents

Show Page Sections

thumbnailHeretto Deploy Portal

Heretto Deploy Portal

Heretto API Docs

Heretto API Docs Overview

Heretto API Docs lets you deliver API documentation and testing capabilities within your instance of Heretto Deploy Portal. This means your API documentation can be available in the same place as all of your other documentation.

Using Heretto API Docs unifies your technical documentation, providing a single point of access for both authors and users.

Heretto CCMS is OpenAPI compliant. It converts your JSON files containing API endpoint definitions into help portal pages in your Heretto Deploy Portal. You can use these pages, generated directly from your JSON files, to:
  • Reference API endpoint attributes and properties
  • Test parameter values by making an API call to a specified server
  • Generate a usable Request Sample rendered in commonly used programming languages with the values you provided
Tip:

To see API Docs in action, take a look at Heretto's Deploy API documentation. See Heretto Deploy API Overview.

Create API Documentation

Heretto CCMS enables you to upload JSON files with API endpoint definitions to automatically create endpoint documentation for your users and customers.

Make sure you have valid a JSON file conforming to OpenAPI specifications.

Note:

HerettoAPI uses OpenAPI specification version 3.0.1. If you have files written according to an older OpenAPI version, or Swagger, Heretto updates these files to the latest OpenAPI version.

  1. Upload JSON files containing endpoint definitions to Heretto.
  2. In the map:
    • Add topicrefs that point to the JSON files and append outputclass="openapi-reference" attribute to each topicref.
    • Add a topicmeta element with a navtitle. Follow the navtitle with topicrefs that point to the JSON files and append outputclass="openapi-reference" attribute to each topicref.
  3. Publish your map.

The API endpoint documentation is delivered to your help site.

A view of published API documentation.

Customize Heretto API Docs Styling

You can customize the layout of the API Docs, similarly to the Heretto Deploy Portal.

API Docs use the same CSS file as Heretto Deploy Portal. For more information on styling, see: Customize Heretto Deploy Portal Styling.