go-gin-api Framework

go-gin-api is a modular API framework built on top of Gin. It is designed to accelerate business development by encapsulating common functions and enforcing structured coding patterns to prevent architectural chaos.

Key Features:

• API Management: Rate-limiting (via rate), CORS support (via cors), and standard RESTful API return values.
• Documentation & Schema: Automatic RESTful API documentation via Swagger and GraphQL support via gqlgen.
• Observability: Metrics monitoring and alerting with Prometheus, internal invocation tracing, and visualized performance analysis via pprof.
• Reliability: Email notifications on panic and uniformly defined error codes using errno.
• Data & Config: ORM support via gorm, Redis support via go-redis, and configuration management via viper.
• Logging: Structured, leveled logging using zap.
• Developer Tools: CURD and controller code generators, and a web interface supported by the Light Year Admin template.

The framework comes with a wide range of integrated components for enterprise-grade API development:

• Rate Limiting: Supports golang.org/x/time/rate.
• Error Handling: Supports unified error code definitions via errno and email notifications upon panic.
• Security & CORS: Supports rs/cors for cross-origin resource sharing.
• Observability:
  • Metrics: Prometheus.
  • Tracing: Internal distributed tracing support.
  • Profiling: pprof.
• Documentation: Swagger for API documentation generation.
• Query Languages: GraphQL support.
• Logging: zap for high-performance logging.
• Configuration: viper for configuration file parsing.
• Data & Storage:
  • ORM: gorm.
  • Cache: go-redis.
• Communication:
  • RESTful API: Standardized return value specifications.
  • WebSocket: Real-time communication via gorilla/websocket.
• Automation & Tools:
  • Code Generation: Generates CURD (Create, Read, Update, Delete) code and controller methods.
  • Scheduled Tasks: cron with a web interface for configuration.
• Admin Interface: A web UI based on the Light Year Admin template.

The Bootstrap Table Pipelining plugin enables client-side data caching for server-side requests. This optimizes performance for large datasets by reducing the number of server requests during page changes. Instead of requesting a single page, the plugin requests a 'cache window' of data (defined by pipelineSize) and caches it locally.

Important Server-Side Requirement: Your server-side implementation MUST use the limit (equal to pipelineSize) and offset parameters to return only the data within the requested cache window, along with the total number of rows.

<!-- Assumes bootstrap and bootstrap-table assets are already imported -->
<script src="/path/to/bootstrap-table-pipeline.js"></script>

<table id="pipeline_table" 
    class="table table-striped"
    data-method='post'
    data-use-pipeline="true"
    data-pipeline-size="5000"
    data-pagination="true"
    data-side-pagination="server"
    data-page-size="50">
    <thead
        <tr
        <th data-field="type" data-sortable="true">Type</th>
        <th data-field="value" data-sortable="true">Value</th>
        <th data-field="date" data-sortable="true">Date</th>
    </tr>
</thead>
</table>

The gormgen tool generates a specialized Query Builder for each model to provide a type-safe, fluent API for database operations. The generated code includes a model struct and a corresponding Query Builder struct.

Key features of the generated Query Builder include:

• Fluent Interface: Methods like Limit, Offset, and Where... return the builder instance to allow chaining.
• CRUD Operations: Built-in methods for Create, Updates, Delete, Count, First, QueryOne, and QueryAll.
• Type-Safe Filtering: For every field in the model, the generator creates specific Where[FieldName], Where[FieldName]In, and Where[FieldName]NotIn methods.
• Ordering: OrderBy[FieldName](asc bool) methods for sorting results.

Note: Files generated by this tool are marked with a warning header and should not be edited manually, as changes will be overwritten during regeneration.