Vastuu Group
API Engine - Automated API documentation
API Engine logo

2-click solution with generated code examples

API Engine, one of the digital services offered by Platform of Trust, aims to reduce developers' pain by taking away the manual effort of generating and updating API documentations. Additional advantages are Code samples, generated in parallel, to reduce time and resource allocations for manual development efforts.

Originally developed to maintain Platform of Trust APIs, API Engine takes machine-readable API specs in Open API Spec (OAS) - version 2 format as inputs and automatically generates human-friendly API documentation with enhanced readability. Developer eXperience is taken one step further by simultaneously producing ready-to-be-used code examples for all API endpoints and methods within the spec file.

API providers can simply focus on improving API functionalities and performance as generating documentations is now a simple 2-click action! Generated code examples reduce the effort to learn the know-hows of API usage, hence enabling third party developers to ensure great user experience on offered services

Features in a nutshell

  • Generate API documents from specs given as an URL or uploaded file
  • Produce sample codes in Java, Python, cURL, and Javascript for each API endpoint and method (more languages coming up soon!)
  • Validate and Execute generated code examples (optional, requires test API environment)
  • Store generated documentation and sample codes in your customized subdomain (with no worries about hosting)
  • Take advantage of white-label branding (customized logo and CSS for look-&-feel) for creating a SaaS solution
  • With API Engine, we ensure 99% service level agreement (SLA) and added community support in Stack Overflow
GO TO API ENGINE
“Our aim is to make developers love APIs! Automated API documentation is one of the best ways to do that.”
Jarkko Moilanen
 – Developer Experience Lead, Platform of Trust

Coming in 2020

  • Automatic update in generated API documentation when specs (given as URL) are changed
  • Version support (with options to revert back in maximum 5 steps)
  • Visualized documentation and code example generation processing showing progress and errors (if occurred)
  • Support for multiple APIs in single spec input