This directory contains comprehensive documentation for the DIDentity decentralized identity platform.

• Complete API Specification - Full OpenAPI 3.0 specification covering all services
• API Reference Guide - Detailed endpoint documentation with examples
• API Integration Guide - Practical implementation examples and best practices

• Developer Guide - Basic development setup and testing

Start with the API Reference Guide for:

• Complete endpoint documentation
• Request/response examples
• Authentication requirements
• Error handling

See the API Integration Guide for:

• Multi-language code examples
• Complete workflow implementations
• Error handling patterns
• Performance optimization

Use the API Specification for:

• SDK generation
• API testing tools
• Documentation generators
• Contract testing

• Authentication Flow - JWT token management and refresh
• DID Methods - Support for key, web, ethr, sov, ion methods
• Credential Types - Education, identity, professional credentials
• Error Handling - Comprehensive error scenarios and responses
• Rate Limiting - Service limits and best practices
• SDK Generation - Multi-language client generation

1. Quick Integration: Start with the curl examples in the API Reference
2. Language-Specific: Check the Integration Guide for your language
3. SDK Generation: Use the OpenAPI spec with code generators

# Test the complete workflow
curl -X POST http://localhost:8004/signup \
  -H "Content-Type: application/json" \
  -d '{"username": "test", "email": "[email protected]", "password": "password123"}'

# Generate TypeScript SDK
openapi-generator-cli generate \
  -i docs/api-documentation.yaml \
  -g typescript-axios \
  -o ./generated-sdk

• Main README: ../README.md - Project overview and setup
• Interactive Demo: ../interactive_demo.py - GUI-based testing
• Docker Setup: ../docker-compose.yml - Service configuration

When updating the API documentation:

1. Update the OpenAPI specification first
2. Reflect changes in the Reference Guide
3. Add examples to the Integration Guide
4. Update this README if new files are added

Note: This documentation is automatically tested against the live services. All examples and code snippets are verified to work with the current implementation.