Customer Management API

Comprehensive REST API documentation and technical writing showcase

Technical writer's guide

Complete learning journey covering both generated documentation and manual YAML writing approaches.

Start learning

Generated documentation

Learn code-first approach using SpringDoc annotations to auto-generate OpenAPI specs.

Code-first approach

Manual YAML writing

Master design-first approach with hand-crafted OpenAPI specifications in YAML.

Design-first approach

Testing and validation

Systematic approaches for testing API documentation accuracy and quality.

Testing guide

Publishing documentation

Deploy API docs for public consumption using static HTML, GitHub Pages, and cloud platforms.

Publishing guide

Reference materials

OpenAPI examples, SpringDoc annotations, testing tools, and troubleshooting guides.

View references

What this demonstrates

• Complete CRUD API with validation and error handling
• Professional documentation using modern OpenAPI 3.0 patterns
• Two documentation approaches - generated vs manual
• Testing resources - Postman collections and validation guides
• Technical writing skills - clear, comprehensive documentation