bunjs-apidog

This skill provides a robust framework for managing API documentation within Bun.js ecosystems. It is designed for backend developers and API engineers who need to maintain synchronized, high-quality OpenAPI 3.0 specifications while leveraging the Apidog platform for design, testing, and mocking. By enforcing strict camelCase naming conventions and reusable component-based schema design, the skill ensures that your API contracts remain consistent with TypeScript standards and industry best practices. It streamlines the lifecycle of API documentation, from initial spec authoring to automated synchronization with remote Apidog projects via REST API integration.

• Generate compliant OpenAPI 3.0 specifications for Bun.js HTTP server routes and data models.

• Automate the import and synchronization of API specifications into Apidog projects using environment-based authentication.

• Implement reusable schemas within components.schemas to reduce redundancy and ensure type safety across API definitions.

• Enforce camelCase JSON field naming to guarantee 1:1 mapping with TypeScript interfaces and industry-standard client generation.

• Utilize Apidog platform features including visual API design, interactive documentation, automated testing, and mock server capabilities.

• Manage complex API structures, including security schemes (JWT bearerAuth), pagination models, and error response standards.

• Requires environment variables APIDOG_PROJECT_ID and APIDOG_API_TOKEN to be configured for remote synchronization.

• Designed for use alongside other Bun.js development skills to maintain architectural consistency.

• Focuses on static analysis and documentation generation; ensure specs are regularly synchronized to match production code changes.

• Use this skill when documenting new endpoints, refactoring existing data contracts, or setting up CI/CD workflows that require up-to-date API documentation.

• Always validate generated specifications against standard OpenAPI parsers to catch schema definition errors before Apidog import.