Reference materials
This section provides comprehensive reference materials to support your API documentation work. Use these resources as quick references, troubleshooting guides, and example templates.
Available references
OpenAPI examples reference
Templates, examples, and reusable patterns for creating OpenAPI documentation. Includes complete schemas, request/response examples, and testing data sets.
What you’ll find:
- Complete OpenAPI document templates
- Customer API schema examples
- Request and response examples for all operations
- Common OpenAPI patterns and best practices
- Ready-to-use cURL commands
- Testing data sets for validation
SpringDoc annotation reference
Comprehensive documentation of SpringDoc annotations used to generate OpenAPI documentation from Java code. Essential for understanding the code-first approach.
What you’ll find:
- Complete annotation syntax and usage
- Code examples for each annotation type
- Generated OpenAPI output examples
- Best practices for technical writers
- Collaboration guidelines with developers
- Common issues and solutions
API testing tools comparison
Side-by-side comparison of tools for testing and validating API documentation. Helps you choose the right tool for your workflow.
What you’ll find:
- 10+ testing tools with examples
- cURL, Postman, HTTPie, Insomnia comparisons
- VS Code REST Client setup
- Tool-specific request formats
- When to use each tool
- Integration workflows
Postman setup guide
Step-by-step guide for creating professional Postman collections from your API documentation.
What you’ll find:
- Collection creation from scratch
- Environment variable setup
- Authentication configuration
- Test script examples
- Organization best practices
- Export and sharing workflows
Postman export guide
Complete instructions for exporting and sharing Postman collections professionally.
What you’ll find:
- Export process step-by-step
- File naming conventions
- Directory organization
- Version control integration
- Team collaboration workflows
- Professional collection enhancement
Postman request data examples
Ready-to-use request examples and data for comprehensive API testing.
What you’ll find:
- Complete request examples for all endpoints
- Test data sets for different scenarios
- Error condition examples
- Authentication examples
- Batch operation data
- Edge case testing data
Troubleshooting guide
Common issues and solutions for API documentation workflows.
What you’ll find:
- Documentation generation problems
- Validation errors and fixes
- Tool configuration issues
- GitHub Pages deployment problems
- Testing workflow troubleshooting
- Performance optimization tips
Quick navigation
Getting started:
- Technical writer’s guide - Start here for the complete learning journey
- OpenAPI examples - Ready-to-use templates and patterns
Implementation approaches:
- Generated documentation guide - Code-first approach
- Manual YAML writing guide - Design-first approach
Testing and validation:
- Testing and validation guide - Systematic testing approaches
- Tools comparison - Choose the right testing tools
Deployment:
- Publishing documentation guide - Deploy for public consumption
These reference materials support both the generated documentation (code-first) and manual YAML writing (design-first) approaches covered in the main guides.