Long-time readers will know that opportunities for me to document APIs have come only from open-source and freelancing work. And those have been few and far between.
Excited to report that I’m helping the dev team at my workplace to document our new customer web API which is being built from the ground up!
So far, I’ve contributed definitions and descriptions, and refined some tags and the info object. I have also been asked to ensure consistency in the naming of resources and JSON field names which is my happy place.
And, I also get to write the welcome and getting started conceptual topics along with helping with the API reference doc. I’ll also get to learn how to annotate in the code, instead of trying to manage the YAML file so that’s also exciting.
Jody Winter 