API and Developer Documentation

Capability portfolio

API & Developer Documentation

I treat API documentation as part of the product experience. The work starts with the actual behavior, not the endpoint list.

Sinch developer documentation with Node.js example

My approach

1. Map the developer journey

I identify what a developer needs before the first request, including credentials, authentication, prerequisites, environment details, and expected responses.

2. Validate the real behavior

I test requests, JSON, CLI behavior, error responses, and code samples instead of documenting assumptions.

3. Design for reuse

I normalize schemas, enums, reusable components, terminology, and error patterns so the experience stays consistent across the API surface.

4. Measure success

I look for faster onboarding, fewer gaps, clearer errors, successful first calls, and content that remains maintainable as the product evolves.

Sinch: SMS and Numbers APIs

Standardized OpenAPI and Swagger definitions across approximately 75% of the active SMS and Numbers API surface. I added missing enums, improved unclear error messages, validated code samples across seven languages, and created onboarding content for a faster first successful API call.

  • OpenAPI and Swagger normalization
  • Redocly developer portal content
  • GitHub-based docs-as-code workflow
  • Python, Java, C++, C#, JavaScript, PHP, and cURL validation
  • Authentication, messaging requirements, FAQs, and support content
Interactive API documentation created for a custom React portal

Orbis: initial API launch

Documented approximately 56 endpoints for an initial launch using OpenAPI, SwaggerHub, Postman, and React. The work included authentication, JWT handling, error models, versioning, event-driven behavior, multi-language samples, and interactive try-it-out functionality.

AWS: source-informed API reference

Produced 4,000 to 5,000 lines of API reference for AWS Deadline Cloud in approximately four weeks. I analyzed service models and source material, resolved gaps with engineers, and validated the generated output. Across AWS IoT launches, I also influenced API semantics, JSON models, naming conventions, and terminology during engineering planning.

Video walkthrough: AWS Deadline Cloud API reference

See how the API reference organizes operations, request and response structures, and reusable data types into a navigable developer experience.

AWS IoT SiteWise gateway walkthrough

This walkthrough demonstrates how I structured procedural guidance for installing, configuring, and using an AWS IoT SiteWise gateway. It connects architecture, prerequisites, configuration steps, and verification in one customer journey.

Tools

OpenAPI • Swagger • SwaggerHub • Redocly • Postman • Git • GitHub • Markdown • XML • React • AWS CLI