Job Responsibilities:
- Write clear structured and detailed API specifications ensuring comprehensive endpoint documentation.
- Define data schemas business rules and validation logic incorporating cross-resource dependencies.
- Establish error handling standards and validation rules to improve API reliability and consistency.
- Collaborate with engineering and product teams to refine API specifications and ensure seamless integration.
- Develop API documentation using Markdown OpenAPI/Swagger JSON Schema and tools such as Postman or Stoplight.
Job Requirements:
- At least 5 years of experience in backend development primarily with .
- API Design Expertise Experience in designing RESTful APIs for complex systems handling at least 5 related API resources (e.g. database tables microservices).
- Data Modeling & Schema Design Strong understanding of relational and non-relational data structures constraints and validation rules.
- API Documentation Standards Proficiency with Markdown OpenAPI/Swagger JSON Schema and documentation tools like Postman Stoplight or .
- Technical Writing Ability to write clear structured and unambiguous API specifications covering business rules and edge cases.
- HTTP & REST Protocol Knowledge Deep understanding of HTTP methods response codes headers authentication and error handling.
- API Lifecycle Management Familiarity with API versioning strategies deprecation policies and backward compatibility.
- Testing & Validation Experience with API contract testing automated validation and error response consistency.
Domain Knowledge:
- Business Logic Translation Ability to convert complex business requirements into well-structured API specifications.
- Cross-Resource Rules Expertise in defining relationships dependencies and constraints across multiple API resources.
- Edge Case Handling Ability to anticipate and document exceptional scenarios and fallback mechanisms.
- Validation Logic Strong understanding of input validation error messages and business rule enforcement.
technical writing,contract testing,api lifecycle management,api,error handling,api design,api documentation,nodejs,schema design,backend development,validation logic,data modeling,http protocol,rest protocol