API Primer - a work in progress

  • 10
  • Idea
  • Updated 3 months ago
I mentioned in a post on another thread that I had done some initial work on an API primer, mainly as a way of corralling my own learning processes as I went along. Various people have expressed an interest in this work, so I have put the current version on my Dropbox here:

https://www.dropbox.com/s/egw5j6u6jc32sj6/A%20Flex%206000%20API%20Primer.pdf?dl=0

I must emphasise that this document is far from complete. If it is useful then I will continue adding the other sections - you can see the outline for the missing bits.

So, budding API developers, does this help? Please let me know.
Photo of John G3WGV

John G3WGV

  • 201 Posts
  • 39 Reply Likes
  • A lot of typing coming on

Posted 3 years ago

  • 10
Photo of Dave AA6YQ

Dave AA6YQ

  • 208 Posts
  • 229 Reply Likes
Re " I can understand that the Flex team have limited resources and by far the best use of those resources is to continue developing the product."

An ecosystem populated by attractive complementary products requires a functional, well-documented API. Such ecosystems can be powerful differentiators and force multipliers, attracting the innovation and productivity of many more developers than the core team can afford to pay or orchestrate. A thriving ecosystem can also provide a steady stream of acquisition candidates.

The Flex API Wiki is usable, but full of gaps; while Flex personnel have been very responsive to questions created by those gaps, comprehensive descriptions of all functions and illustrative examples are needed to attract broad interest from the amateur developer community.
(Edited)
Photo of John G3WGV

John G3WGV

  • 201 Posts
  • 39 Reply Likes
Hi Dave, long time no see!

I entirely agree with you. In an ideal world the API would be fully documented and we wouldn't have to delve into the FlexLib API code. I know you've done a lot of work on the Wiki, which is great. I found it hard work finding enough information to get started, so my primer is an attempt to help others at that early stage. A bit of self help from within the community is no bad thing.