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

 

Developer Relations and APIs

 

API Documentation Examples

 

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

 

API Documentation Generation Tools

 

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

 

Facebook / Parse (BaaS) API Shutdown Example

 

Evans Data Developer Program Workshops and Assessments

 

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

 

David I - Developer Relations Conference

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/

Connected Cars, Voice Control and AI News at CES 2017

As predicted, there has been a flurry of announcements by automotive companies related to autonomous vehicles, voice control and the use of AI at this year’s CES 2017. I’ve previously blogged about “Developer Relations Programs for Self Driving and Connected Cars“, “Developer Relations: Doing Great Things with Telematics” and “Voice Control APIs“. At this week’s CES 2017 show in Las Vegas, there have been several announcements and articles about the coming together of connected cars, voice control and AI. It’s so cool to see collaborations between car, platform, cloud and machine learning companies to bring next generation features to automobiles. Here are just a few of the many Connected Cars, Voice Control and AI articles coming out of CES 2017 Las Vegas.

Connected Cars, Voice Control and AI

Connected Cars, Voice Control and AI News

 

pexels-photo-290470

 

CES 2017 Automotive Related Keynotes

 

Connected Cars, Voice Control and AI

 

Exciting Automotive Times for Sure!

 

David I - Developer Relations Conference

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

 

OK, Code is King! But, where should you put your Developer Relations sample programs?

All developers require a Developer Relations Programs to follow the “3 C’s” – Community, Code and Content. To this list of C’s I also add a few of my own: Collaboration, Continuity, Cooperation, Communication, Caring, Celebration, Civility, Consideration, Clarity, Conversation and Curiosity. In surveys, during conversations, in emails and as the most commonly asked webinar question, developers tell us that Code is King! Even though we provide documentation for SDKs, APIs, libraries, frameworks, systems and applications, the ultimate documentation is the source code itself. The Computer History Museum (CHM) collects the source code for great computer software programs and systems. Do you want to download the source code for MacPaint and QuickDraw created by Bill Atkinson? You can download them both and you can read the story behind the software too! I love what CHM is doing to preserve the source code artifacts of our industry’s history. Developers tell Evans Data that source code examples, sample projects and tutorials are some of the top requirements for a successful developer relations program. So, the question is, where should you put your sample programs so that your developer relations program members can find it, download it and use it?

Developer Relations – where to put your sample programs, tutorials and source code?

There are several places that Developer Relations programs put there source code. Some programs keep their code on their own servers (ftp or http access), some put code in public repositories and others put their source on code hosting sites. There are many sites to choose from including: Amazon S3, Microsoft Azure StorageGitHubSourceForge, DropBoxCloud Forge, BoxCodePlex, Google DriveAssemblaBitBucket, ProjectLocker, and LaunchPad. Most of these sites support the leading source code version control services including Subversion, Git and Mercurial. Some of the hosting sites will also provide additional tools and services like defect tracking, deploy/install, security scanning, and license compliance audits. Several of these sites are popular places to put open source software projects allowing the developer community to collaborate and enhance the sample code. Some of the sites also provide APIs (GitHub Developer for example) for you to automate interactions, search catalogs of entries, access control, and more. Other developer programs place source code on sites to make it simple to distribute and update the code. Most integrated development environments and programmer’s editors support pulling sample code from repositories.

Sample Programs

Where do you put your Developer Relations program and products sample code?

Send me an email and tell me where you put your developer relations program code.

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