Automatically generate resource-centric documentation from OpenAPI specifications with relationship diagrams, capability matrices, and semantic analysis.

This is an AI-written project, built with modern software engineering practices.

🚧 Pre-Alpha Development - This project is in early development. Core functionality is being implemented.

Implemented:

• Project structure and documentation
• Vision and architecture design

In Progress:

• Makefile and build system
• OpenAPI/Swagger parsing
• Resource analysis engine

Planned:

• CLI interface
• Multiple output formats (Markdown, JSON, AI-optimized)
• Relationship detection and visualization

See tasks.md for detailed development progress.

• Resource-centric documentation
• Relationship visualization
• Pattern recognition
• AI-optimized output
• Single binary distribution

go install github.com/orchard9/pg-goapi@latest
pg-goapi api-spec.json

PG GoAPI generates documentation containing:

• Resource hierarchy with relationships
• Grouped endpoints by business capability
• Capability matrix showing available operations
• Common patterns (pagination, filtering, auth)
• Mermaid relationship diagrams

📄 Sample Output - Will be generated through UAT process once core functionality is implemented

git clone https://github.com/orchard9/pg-goapi
cd pg-goapi
go build -o pg-goapi cmd/pg-goapi/main.go

go install github.com/orchard9/pg-goapi@latest

• OpenAPI 3.x specifications
• Go 1.21+ (for building from source)

• Usage Guide
• Architecture
• Contributing
• Why PG GoAPI?

MIT License. See LICENSE.md for details.

Report issues at https://github.com/orchard9/pg-goapi/issues