Best Reference Documentation beyond REST APIs

What makes a developer portal stand out in guiding non-REST API integration journeys?

 

We are looking for developer portals that improve API reference documentation for a portfolio including GraphQL, asynchronous APIs, or other APIs. Success in this category means that a user is experiencing no obstacles when integrating, finding extras to speed up their work, learning how to find support if needed, and figuring out how to maintain an integration with non-REST APIs.

These developer portals serve their audience well with an engaging design, reference topics, and being creative in making the API reference documentation journey easy and discoverable.

Evaluation includes navigation, appearance, utility, how easy to use, and completeness.

Award Criteria

Questions to ask:

 

  • How do users find relevant information regardless of API type?

     
  • Is there sufficient organization to the information provided or is it everything and the kitchen sink?

     
  • As a registered user, can I access information that is relevant to the API product's use?

     
  • How does your devportal improve on basic API reference documentation from an end user's point of view?

     
  • What special guidance is provided to ease a user’s journey into using the non-REST APIs?

     
  • How do you support the user's conceptual understanding of the domain and processes?

     
  • How do you provide “try it out” and sandbox functionality?

     
  • How do you support developer needs? E.g. code examples, interactive documentation, multiple coding languages, anchor links, dark mode, easy navigation, ...

     
  • How can users find solutions to problems that occurred?

     
  • How do you communicate versioning and track changes?

Nominees in this Category

Syncfusion, Inc.

Bold Reports Developer Portal (2024)

Syncfusion, Inc.

Bold BI Developer Portal (2024)

Syncfusion Inc.

Syncfusion Essential Studio (2024)

Maya Philippines, Inc.

Maya Developer Hub (2024)

Lucid Software Inc.

Lucid Developer Platform (2024)

Cisco Meraki

Cisco Meraki Developer Hub (2024)

XRP Ledger Foundation

XRP Ledger Developer Resources (2024)

Viam

Viam Documentation (2024)

Electromagnetic Field

Tildagon Badge Documentation (2024)

Miro

Miro Developer Platform (2024)

Paymob

Paymob Developer Hub (2024)

NewDay Technology Ltd

NewDay Developer Portal (2024)

UPS

UPS Developer Portal (2024)

Worldpay Developer Hub home page screenshot

Worldpay

Worldpay Developer Hub (2024)

Onfido Documentation Portal home page screenshot

Onfido

Onfido Documentation Portal (2024)

DHL API Developer Portal front page screenshot

DHL Group

DHL API Developer Portal (2024)

Mapbox Docs home page

Mapbox, Inc.

Mapbox Docs (2024)

Skyflow

Skyflow Docs (2024)