Documenting web APIs with the Swagger / OpenAPI specification in Drupal

Developer Portals Technology

Documenting web APIs with the Swagger / OpenAPI specification in Drupal

April 20, 2017

As part of our work to make Drupal 8 the leading CMS for developer portals, we are implementing a mechanism to import the OpenAPI (formerly known as Swagger) specification format. This is a crucial feature not only for dedicated developer portals, but also for all Drupal sites that are exposing an API. Now that it has become much easier to create a RESTful API service in Drupal 8, the next step is to make it more straightforward to create its API reference documentation. That is why we think our work will be useful for site builders, and not just for technical writers and API product owners.

Read more
Web APIs in Drupal: success takes more than an endpoint

Developer Portals Technology

Web APIs in Drupal: success takes more than an endpoint

March 23, 2017

Web APIs are not just useful when making headless sites in Drupal: large Drupal sites often hold valuable information that could also be useful outside the site's context. Media companies might want to expose historical media content, community sites could show data about their community activities, e-commerce sites tend to open an API for their affiliates and partners.

While it is possible to use Drupal 7 and Drupal 8 as an API backend, a lot of functionalities that describe a mature API service do not come out of the box. In this post we will explain what key concepts you have to keep in mind when designing an API service, why they are important and how APIgee Edge can make it easier to build a full-featured API webservice in Drupal successfully.

Read more
7 Trust Signals That Help an API Succeed - Developer Portal Strategy Part 1

Developer Portals Technology

7 Trust Signals That Help an API Succeed - Developer Portal Strategy Part 1

January 25, 2017

Developer portals are important for your API's adoption and support. They are also a trust signal: a well designed and actively maintained developer portal shows that an organization is investing in its APIs. It helps convince developers that they can rely on them. In this post I’ll zoom in on the trust signals business model, partner policy, API quality, API uptime status, versioning policy, documentation and developer portal production quality.

Read more
Graph databases in Drupal: a Neo4j module that integrates with Rules

Technology

Graph databases in Drupal: a Neo4j module that integrates with Rules

January 13, 2017

SQL databases are really fast when you need all the information stored together in a record row, but they are a bad fit when you need to search for relationship patterns that are not already stored together in your database. A significant performance penalty is incurred for every additional table that needs to be joined for a query. That is why SQL databases are notoriously bad at deducting relationships from datasets. Graph databases however are really good at this task.

Read more
Developer Portal Components - Part 6: Software Development Kits (SDKs)

Developer Portals Technology

Developer Portal Components - Part 6: Software Development Kits (SDKs)

December 23, 2016

The main purpose of Platform Software Development Kits and Helper/Client Libraries is to accelerate and simplify development. A well maintained SDK is a trust signal that indicates the level of support and usage of your API for a language, framework, or development platform. So indirectly SDKs work as social proof, indicating how many communities are already using your API.

In this post, we’ll look at how the developer portals in our research sample included SDKs. We’ll examine their functions, describe where we found them in the site architecture and deduct best practices. We’ll discuss what kind of SDKs the Portals in our sample used. We’ll analyze their choices and evaluate them against the principles that Taylor Barnett from Keen IO shared at APIstrat earlier this year. We’ll also talk about the strategic choices that need to be made when deciding what kind of SDKs an API should have.

Read more
5 Things to Learn from Twilio’s documentation overhaul

Developer Portals Technology

5 Things to Learn from Twilio’s documentation overhaul

December 13, 2016

Twilio is regarded as one of the API industry’s leaders, so when, after five years, Twilio changes the documentation format on their developer portal, everybody wants to know why. Jarod Reyes and Andrew Baker (both developers of Twilio's developer education team) gave a presentation about the reason for the changes at SIGNAL 2016. Because we found them valuable and wanted to share them with our developer portal mailinglist, we’ll summarize their findings in this blog post.

Read more