API and tools¶
I have extensive experience creating API documentation. For example, from 2023 to present (2025), I have taken an established software company with a complex set of APIs from having no API documentation to having a robust and detailed API reference for each API. This documentation has increased company revenue by attracting new customers and also helping to retain existing customers who demanded documentation for the APIs. For this company alone, the API references that I created include more than 50 pages and 200 endpoints.
The following links show you two pages out of the various large API references that I created:
API documentation and testing tools¶
For testing APIs and gathering the information for documentation, I have used various tools. For small demonstrations of what I can do in those tools, see the following sections.
MkDocs¶
The site you are currently viewing is an example I have built with the Python-based MkDocs static site generator. I stored the site files in GitHub, and edited them in Visual Studio Code. I published the site to GitHub Pages via an Action. In addition to the API pages referenced earlier, this site includes the following API doc samples that I built with the specified UI tool integrations:
- Swagger UI (aka OpenAPI) Pet Store Example
- Stoplight UI Pet Store Example
- Swagger UI Manage Rate Plan Example
- Stoplight UI Hotel Availability Example
Next.js¶
I have built a site with the React-based Next.js static site generator. For this site, I stored the site files in GitHub, and edited them in Visual Studio Code. I then used a GitHub Action to publish the site to Vercel. The site is an ongoing (not totally polished) project. You can see an API page and access the rest of the site here:
- Next.js doc site published to Vercel
Postman¶
To demonstrate my capabilities for building API documentation with the Postman Collections tool, I created the following small sample doc sites:
Madcap Flare and Zendesk¶
For publishing API documentation, I have also used various methods. I have published with Postman and OpenAPI (as demonstrated in the preceding sections).
To fit the requirements of one company, I created a large API documentation set that I published simultaneously (content reuse in multiple channels) to a Madcap Flare site and a Zendesk Guide Help site. The following links show you two of those pages:
API course certificates¶
Also, here are certificates for a few of the API courses that I've completed.
