API Technical Writer

MaxRidge Private Limited; Dadri; On-site; INR 600,000 - 900,000; Full time

Job summary

MaxRidge Private Limited is seeking an API Technical Writer to translate complex technical concepts into clear, developer-friendly documentation. The role focuses on API Reference Documents, Integration Guides, Tutorials, and Developer Guides to support a growing developer ecosystem.

Ideal candidates have 2–5 years of experience in technical writing for APIs, strong knowledge of OpenAPI / Swagger, and collaboration skills with cross-functional teams to ensure accurate, up-to-date documentation

Qualifications

• 2–5 years in Technical Writing, API Documentation, or a similar role
• Strong knowledge of API concepts and RESTful APIs
• 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

Responsibilities

• Create API Reference Documentation, Integration Guides, Tutorials, and Developer Guides
• Translate complex technical concepts into clear, developer-friendly docs
• Collaborate with developers, architects, QA, product managers, and engineering teams
• Maintain documentation portals and version control for docs

Skills

API Documentation

Swagger / OpenAPI

OpenAPI specifications

REST APIs

JSON / XML

OAuth / JWT

Developer portals

Education

Graduation

Tools

Swagger

OpenAPI

Git/GitHub

Job description

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

What We’re Looking For

• 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

Maxridge is hiring for API Technical Writer in Noida, India.