Articles
Everything on developer portals from strategy and business to technology and visual design.
Sign up to our newsletter to make sure you don't miss out.
Categories
by 9 years 5 months ago
Documenting web APIs with the Swagger / OpenAPI specification in Drupal
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.
Categories: Technical Solutions
The 8 Stakeholders of Developer Portals
Different stakeholders interact with a developer portal throughout an API’s lifecycle. In this post we list 8 stakeholders and explain what they need to do their jobs.
Categories: UX & Research
Web APIs in Drupal: success takes more than an endpoint
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.
Categories: Technical Solutions
Should Documentation Be Part of the Definition of Done?
Where does technical documentation stand with agile development methods? Watch and read about the talk Rob Woodgate (@agiledoc) did at the Write the Docs London-GDS mini conference on the practice of agile documentation.
Categories: Business Insights
Using Graph Databases in Popular Open Source CMSs
In a talk we did at FOSDEM ‘17, Tamás Demeter-Haludka and I discuss __potential application areas of graph databases in existing open source CMSs like Drupal__.
Categories: Technical Solutions
7 Trust Signals That Help an API Succeed
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.
Categories: Business Insights