Developer Relations and your Company’s APIs – webinar info and links

This week, I am presenting a DevRelate webinar, “Developer Relations and your Company’s APIs” on Wednesday (May 31) and Thursday (June 1). This blog post contains additional information and links covered in the webinar.

APIs and Your Company

• “Developers Demand Programs to Support APIs” – Evans Data Press Release May 3, 2017
• “The Impact of APIs on Firm Performance” – Boston University Questrom School of Business Research Paper No. 2843326, last updated May 23, 2017
• Importance of APIs to your company’s strategy – find insights in the Evans Data Global Development Survey v1 2017

 

Developer Relations and APIs

• 23 Top Content Bits to Connect to Each of your Developer Relations Assets
• Adam Rogal’s (Uber) Evans Data Developer Relations Conference 2017 Keynote – Evolution of a Developer Platform: an Inside Out Journey

 

API Documentation Examples

• Twilio – https://www.twilio.com/docs/
• Stripe – https://stripe.com/docs
• Slack – https://slack.com/developers
• Visa API Explorer: https://developer.visa.com/apiexplorer
• Vantiv triPOS: uses Swagger documentation

 

API Versioning – Overview

 

REST

• URI
• Request parameter
• Media type (aka content negotiation & accept header)
• Date
• Custom request header
• Domain name

 

SOAP

• XML namespaces and XML comments
• UDDI version aware service registry

 

Shared Code Files

• Filename
• Version resource

 

API Resource Links

• How are REST APIs versioned?
• API versioning methods, a brief reference
• Open API Initiative
• REST API Design Tips from Experience – A working guide of API design tips and trend evaluations.

 

API Documentation Generation Tools

• Swagger API tooling and Swagger Open Source Integrations
• Doxygen – tool for generating documentation from source code (C++, Objective-C, C#, PHP, Java, Python, etc.)
• Sphinx – documentation generator for Python
• Doc-O-Matic – source code documentation and help authoring tool
• Apiary – Interactive Documentation

 

Additional Swagger Resources

The following Swagger related links were provided by SmartBear Software (thank you Keshav and Tracy)

1. [Blog] API Design Best Practices – https://swaggerhub.com/blog/api-design/api-design-best-practices/
2. [Blog] What is API Design, and Why it Matters – https://swaggerhub.com/blog/api-design/what-is-api-design/
3. [Webinar] Scaling your API Design Process – https://swaggerhub.com/blog/api-design/scaling-your-api-design/
4. [eBook] Optimizing the Swagger collaborative workflow using SwaggerHub – https://swaggerhub.com/blog/api-resources/optimize-your-swagger-api-workflow/
5. [Blog] Design first or Code first approach to APIs – https://swaggerhub.com/blog/api-design/design-first-or-code-first-api-development/
6. [Webinar] API Developer Experience (DX), and good documentation practices for good DX – https://swaggerhub.com/blog/api-documentation/api-documentation-and-developer-experience/

 

API Versioning – Examples

• AWS SimpleDB – dated version parameter
• Microsoft Azure Storage Services – custom header
• Stripe – dated version parameter
• Twilio – date in URI
• GitHub – media type versioning
• Facebook – URI versioning and migrations

 

Facebook / Parse (BaaS) API Shutdown Example

• Announcement: http://blog.parse.com/announcements/moving-on/
• Reminder: http://blog.parse.com/announcements/a-parse-shutdown-reminder/

 

Evans Data Developer Program Workshops and Assessments

• Program Workshops for Stakeholders and Developer Relations Teams
• Program Assessments – External developer program assessment and In-Depth developer program assessment
• https://evansdata.com/services/workshops-assessments.php

 

If you have additional API links, best practices, tools, tips, tricks, thoughts and questions, send me an email.

 

David Intersimone “David I”
Vice President of Developer Communities
Evans Data Corporation
davidi@evansdata.com
Blog: https://www.devrelate.com/blog/
Skype: davidi99
Twitter: @davidi99
LinkedIn: https://www.linkedin.com/in/davidi99/