5/9/2014 1:08:57 PM
Apigee SmartDocs Provides Developers Method level API Documentation
App Developer Magazine

Apigee SmartDocs Provides Developers Method level API Documentation

Richard Harris Richard Harris in Enterprise Friday, May 9, 2014

Apigee, which provides API management solutions, has introduced SmartDocs, a method-level API documentation that offers both internal and external SEO benefits. 

API providers can generate docs by leveraging handlebars-driven templates, test the accuracy of their documentation with live requests, and control the layout, interactions, and look of docs. App developers can make API requests without leaving the page, work faster as SmartDocs learns the parameter values developers like to use, and benefit from accurate, model-driven documentation.

SmartDocs features include:

Method-level detail: Every method of an API gets its own page of documentation. This gives space to describe the behavior of that method in detail. Not only does that help provide necessary information to developers, the documentation itself is indexed, which brings SEO benefits to internal (portal) search results as well as external search results.

Interactive requests: Developers can send requests without leaving docs. SmartDocs guides developers to build well-formed requests and to sign them with their credentials. This helps minimize a crucial adoption metric - time to first request. And because writers can test their work in-situ, it should improve the accuracy of documentation.

Docs that learn: SmartDocs remembers the values that each developer uses for subsequent requests. This makes SmartDocs a tool that gets better the more it is used and it helps developers move faster.

Easy to maintain: Developers have complete control over the layout, interactions, and look and feel. Plus, in-line editing allows the ability to change what is see, right from the generated docs.

To learn more, Apigee provides SmartDocs introduction documentation. SmartDocs (in beta) supports OAuth 2.0's webserver flow, custom token authentication (API keys), and HTTP basic authentication. With a developer portal and an existing description of services in Swagger or WADL (as used by Apigee API consoles) format, SmartDocs can be published in as little as 10-15 minutes.

Read more: https://blog.apigee.com/detail/apigee_smartdocs_in...


Your name and email will not be public or shared in any way.

Blockchain Basics: A Non-Technical Introduction in 25 Steps

Learn the basics of blockchain technology. No mathematical formulas, program code, or computer science jargon are used. No previous knowledge in computer science, mathematics, programming, or cryptography is required. Terminology is explained through pictures, analogies, and metaphors.

A new way to manage your development projects

Learn the best ways to organize your app development projects, and keep code straight, clients happy, and breathe a easier through launches.

The Latest Nerd Ranch Guide (3rd Edition) to Android Programming

Write and run code every step of the way, using Android Studio to create apps that integrate with other apps, download and display pictures from the web, play sounds, and more. Each chapter and app has been designed and tested to provide the knowledge and experience you need to get started in Android development.

Starting your own app business?

How to create a profitable, sustainable business developing and marketing mobile apps.

Featured Stories

Stay Updated

Sign up for our newsletter for the headlines delivered to you

SuccessFull SignUp

App Developer Magazine January-2019 for Apple and Android mobile app developers