Michael Mainguy a204168c00 Add automatic API documentation system with OpenAPI 3.0 spec

## Features Added:
- **Automatic Documentation Generation**: Uses next-swagger-doc to scan API routes
- **Interactive Swagger UI**: Try-it-out functionality for testing endpoints
- **OpenAPI 3.0 Specification**: Industry-standard API documentation format
- **Comprehensive Schemas**: Type definitions for all request/response objects

## New Documentation System:
- `/docs` - Interactive Swagger UI documentation page
- `/api/docs` - OpenAPI specification JSON endpoint
- `src/lib/swagger.ts` - Documentation configuration and schemas
- Complete JSDoc examples for batch classification endpoint

## Documentation Features:
- Real-time API testing from documentation interface
- Detailed request/response examples and schemas
- Parameter validation and error response documentation
- Organized by tags (Classification, Captioning, Tags, etc.)
- Dark/light mode support with loading states

## AI Roadmap & Guides:
- `AIROADMAP.md` - Comprehensive roadmap for future AI enhancements
- `API_DOCUMENTATION.md` - Complete guide for maintaining documentation

## Benefits:
- Documentation stays automatically synchronized with code changes
- No separate docs to maintain - generated from JSDoc comments
- Professional API documentation for integration and development
- Export capabilities for Postman, Insomnia, and other tools

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

2025-08-27 17:21:53 -05:00

1.5 KiB

Raw Permalink Blame History

nextjs project to display and organize photos

uses tailwindcss for styling
uses next/image for image optimization
uses next/font for font optimization
uses notejs 22

Roadmap

[x] Set up Next.js project with typescript (https://nextjs.org/docs/app/getting-started/installation) [x] Install Tailwind CSS [x] Configure next/image [x] Configure next/font [x] Set up TypeScript [x] initialize git repo with appropriate .gitignore [x] Create responsive layout with Tailwind CSS [x] Integrate localdb for backend photo index data [x] create service to index photos from local filesystem [x] Create photo gallery page [ ] Implement photo organization features (albums, tags, moving files) [ ] Optimize for performance and SEO

Claude Instructions

Never automatically change or add files without user confirmation
Never try to run the dev server, user will always manually run dev
Run builds automatically to check for errors

Code Standards

Files over 300 lines should be split into multiple files
Use functional components with hooks
Use Tailwind CSS for all styling, no custom CSS unless absolutely necessary
Use next/image for all images
Use next/font for all fonts
Write clear, concise, and well-documented code
Double check approach against current frameworks and libraries
Always ask for user confirmation before making large changes

Audit

When asked if there are libraries to accomblish custom functionality, check npm
When asked for alternatives give multiple options with pros and cons
don't change any code unless I confirm