II.
LibraryProcess overview
Reference · livelib-process:technical-documentation--api-reference-docs
specializations/technical-documentation/api-reference-docs overview
API Reference Documentation with Code Examples - Comprehensive process for creating complete API reference documentation with multi-language code examples, authentication flows, error handling, rate limits, SDK integration guides, and interactive API explorers following documentation best practices.
Attributes
displayName
specializations/technical-documentation/api-reference-docs
description
API Reference Documentation with Code Examples - Comprehensive process for creating complete API reference
documentation with multi-language code examples, authentication flows, error handling, rate limits, SDK integration guides,
and interactive API explorers following documentation best practices.
libraryPath
library/specializations/technical-documentation/api-reference-docs.js
specialization
technical-documentation
references
- - Google API Documentation Best Practices: https://cloud.google.com/apis/design
- - Microsoft API Documentation Guidelines: https://github.com/microsoft/api-guidelines
- - OpenAPI Specification: https://swagger.io/specification/
- - Stripe API Documentation: https://stripe.com/docs/api
- - Twilio API Documentation: https://www.twilio.com/docs/usage/api
example
const result = await orchestrate('specializations/technical-documentation/api-reference-docs', {
apiName: 'E-Commerce Platform API',
apiType: 'REST',
specificationPath: 'specs/openapi.yaml',
endpoints: [
{ path: '/products', methods: ['GET', 'POST'] },
{ path: '/orders', methods: ['GET', 'POST'] }
],
targetLanguages: ['javascript', 'python', 'java', 'ruby', 'go'],
targetAudience: 'external-developers',
authType: 'OAuth2',
includeInteractiveExplorer: true
});
usesAgents
- openapi-swagger
- markdown-mdx
- code-sample-validator
- jsdoc-tsdoc
- readme-platform
- tech-writing-lint
Outgoing edges
lib_applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
lib_belongs_to_specialization1
- specialization:technical-documentation·Specialization
lib_implements_workflow1
- workflow:documentation-sprint·WorkflowDocumentation Sprint
lib_involves_role2
- role:technical-writer·RoleTechnical Writer
- role:documentation-engineer·RoleDocumentation Engineer
lib_requires_skill_area2
- skill-area:docs-as-code·SkillAreaDocs-as-Code
- skill-area:reference-docs·SkillAreaReference Documentation
Incoming edges
None.