API Technical Writer

Job Summary

API Technical Writer - Noida, India Hybrid Full Time 3-5 years

MaxRidge is looking for a skilled API Technical Writer to join our growing team! If you have a passion for translating complex technical concepts into clear, developer-friendly documentation, we want to hear from you.

Responsibilities

• Strong experience in Technical Writing / API Documentation

• Strong understanding of APIs and API documentation standards

• Good knowledge of REST APIs, HTTP methods, status codes, JSON, XML, and authentication

• Strong understanding of OpenAPI Specification (OAS)

• Hands-on experience with Swagger / OpenAPI documentation

• Ability to understand API specifications, endpoints, request/response schemas, parameters, headers, and error handling

• Experience creating API Reference Documentation, Integration Guides, Tutorials, and Developer Guides

• Understanding of OAuth 2.0, API Keys, JWT, and other API authentication mechanisms

• Familiarity with developer portals and API documentation platforms

• Ability to collaborate with developers, architects, QA, product managers, and engineering teams

• Excellent written communication and strong attention to detail

  Requirements

• Experience: 2-5 years in Technical Writing, API Documentation, or a similar role

• Technical Requirements: Strong knowledge of API concepts and RESTful APIs

• Good understanding of OpenAPI Specification (OAS)

• Hands-on knowledge of Swagger / Swagger UI / OpenAPI tools

• Ability to read and understand API specifications and developer code

• Familiarity with JSON, XML, HTTP, REST, OAuth, JWT, and API authentication

• Experience documenting endpoints, parameters, schemas, request/response examples, errors, and workflows

• Knowledge of Git/GitHub/GitLab and documentation version control is a plus

• Exposure to API-first development, microservices, cloud platforms, or developer portals is an advantage

  Preferred qualifications

• Graduation

  Skills

• API Documentation / Swagger / Swagger UI / OpenAPI tools

Disclaimer: This job posting has been aggregated from external source. Role details, content, and availability are subject to change. Applicants are advised to confirm the latest information directly on the company website before applying.