-
Notifications
You must be signed in to change notification settings - Fork 32
/
dpa_best_restapi_alternative.liquid
59 lines (37 loc) · 7.4 KB
/
dpa_best_restapi_alternative.liquid
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
---
converter: markdown
metadata:
title: Best Developer Portal for Alternatives to REST-APIs - DevPortal Awards 2021
description: The platformOS Documentation has won the Best Developer Portal for Alternatives to REST-APIs category at the DevPortal Awards 2021.
---
{% include 'awards/dpa2021' %}
In this article, learn about the DevPortal Awards, the judges for the category, and why we won the **Best Developer Portal for Alternatives to REST-APIs** award.
{% include 'shared/video', id: 'i6a3x1pKLKU' %}
{% include 'awards/dpa2021_intro' %}
## Best Developer Portal for Alternatives to REST APIs
As the DevPortal Awards website highlights, documentation is increasingly recognized as a crucial component for any software solution. The first developer portals in the software industry typically focused on documenting REST APIs. However, with the ever-expanding choices of interfaces needing to be integrated (all manner of 3rd party software solutions, physical IoT devices and Web 3.0) software vendors are being challenged to substantially broaden the scope of their documentation, to support developers building across platforms.
This award looks at the application of documentation best practices for non-REST-API integrations. Aspects to consider might include:
* Does your developer portal push the boundaries of integrations?
* Do you have solutions that cater to business as well as citizen developers?
* Is your developer portal focused on other types of integrations, for example serving AI or IoT solutions?
* Have you created a successful system for providing support and documentation for 3rd party integrations?
* What innovative use of widgets, low-code, no-code, SDKs, and other interfaces contribute to the success of the developer portal?
* How easy is it for the target audience to find alternative solutions for integrations?
As one of the judges, Flavio Geraldes explained:
Nowadays when we talk about APIs and API management, everyone kind of assumes that we are talking about REST APIs. But that's not always necessarily the case. As this assumption exists, there is this tendency of making assumptions that people know how to use the services, how to use the products. But sometimes that's not the case. And the portals need not only to explain technically, how to use the service, how to use the products that are available, but also the business behind it. What are the capabilities that are available and how to use them, and what are the business concepts that the developers can take advantage of. We really saw that most of the participants, on one hand, had very clear documentation explaining the technology and how to use it step by step. But on the other hand also alternatives that were being picked exactly because of this ease of use and to make the life of the consumers easier, and environments where REST is not that well-known. It's really interesting that we saw alternatives like widgets or premade UI components that take these integration steps and usability to the next level.
## Judges
The DevPortal Awards are a **peer-reviewed award** where jury members are invited and assigned to categories according to their expertise. In 2021, 11 judges worked on assessing the portals in 3 groups. The judges responsible for selecting the Best Developer Portal for Alternatives to REST-APIs were:
* **Emmely Wang**: [Emmelyn](https://www.linkedin.com/in/emmelyn/) is Global Business Development Leader for AWS Marketplace. She has been serving the technical communication and API community through developer experience advocacy, as an educator, and driving product conversations as an APIOps practitioner.
* **Katrien van Gijsel**: [Katrien](https://www.linkedin.com/in/katrien-van-gijsel/) is a digital enthusiast keen on strategic transformation and challenging environments. After a management traineeship at Fortis AG, she started at KBC in life insurance. 15 years later, with a background in innovation and data science, the new playground is Open & Beyond banking. There, she focuses on business innovation and the KBC DevPortal.
* **Flavio Geraldes**: [Flavio](https://www.linkedin.com/in/flaviogeraldes/) is an experienced Product Manager with a demonstrated history of working in the telecommunications industry. Passionate about digital transformation and driving innovation, it's his desire to re-imagine services using technology to drive new business models.
* **Liz Couto**: [Liz](https://www.linkedin.com/in/liz-couto-57375714/) Couto is a marketer, writer, and speaker based in Toronto, Canada. With over a decade spent working in marketing and advertising, much of her career has been dedicated to programs and tools for developers and API partners. Currently, Liz Couto works as a Sr. Product Marketing Manager for Shopify’s Developer Program, and previously held roles at Twitter Canada and J. Walter Thompson.
Thank you to the judges for providing their expertise and for the enormous effort in evaluating all the nominees in the various categories.
## Why we won
According to the jury members, platformOS was awarded in this category _“for their extensive documentation with videos and tutorials with several scenarios for GraphQL and CLI. On the other hand, it has a very steep learning curve. platformOS explains how to try out their product according to the developer's level of technical expertise and sets proper expectations about different deployment methods. They provide several clear implementation examples including migration from major eCommerce platforms that require more robust content, community, and marketplace capabilities. Kudos to platformOS for reaching front-end developers in addition to back-end integrators.”_
As Adam Broadway, Founder and CEO of platformOS explained, GraphQL is a domain-specific language that we have baked into the core of platformOS along with Liquid markup, both of which are open-source frameworks. We have clear documentation for both, not just the open-source documentation that we synchronize with, but additional support and examples that have really helped our ecosystem of developers get up to speed with them. We want to be able to take a developer who has just come out of working with an older framework dipping their toe into using GraphQL and all the functionality it provides, and hit the ground running as quickly as possible.
Thank you to the organizers and participants of the DevPortal Awards: We are inspired by all the other participants in these awards year after year who drive us on to continue to strive for excellence.
The feedback loop from our community has been amazing, so much so that it has pushed us to constantly improve our documentation and processes. So, as always, thank you to all our team members and members of our community who have contributed to our developer portal.
<img loading="lazy" src="{{ 'images/awards/2021/DPA21_alternativestorestAPIs_quote.png' | asset_url }}" alt="Quote from the Judges" />
## Related
* [API The Docs 2021 — platformOS Developer Portal Demo and Q&A](https://documentation.platformos.com/community/meet-us/api-the-docs21): As the platformOS Documentation has been nominated for the Devportal Awards 2021, we have been invited to showcase our devportal and participate in a Q&A session at the [API The Docs](https://apithedocs.org/virtual-2021/platformos-developer-portal) conference.
* [What goes into an award winning developer portal in 2021?](https://pronovix.com/blog/what-goes-award-winning-developer-portal-2021): Interview with 2021 DevPortal Awards Jury