@ngxtm/devkit 3.3.0 → 3.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli/index.js +59 -13
- package/cli/rules.js +248 -0
- package/package.json +2 -1
- package/rules/README.md +141 -0
- package/rules/dart/best-practices/SKILL.md +23 -0
- package/rules/dart/language/SKILL.md +52 -0
- package/rules/dart/tooling/SKILL.md +43 -0
- package/rules/dotnet/aspnet-core/SKILL.md +92 -0
- package/rules/dotnet/aspnet-core/references/REFERENCE.md +335 -0
- package/rules/dotnet/best-practices/SKILL.md +101 -0
- package/rules/dotnet/best-practices/references/REFERENCE.md +256 -0
- package/rules/dotnet/blazor/SKILL.md +146 -0
- package/rules/dotnet/blazor/references/REFERENCE.md +392 -0
- package/rules/dotnet/language/SKILL.md +82 -0
- package/rules/dotnet/language/references/REFERENCE.md +222 -0
- package/rules/dotnet/patterns.rule.md +388 -0
- package/rules/dotnet/razor-pages/SKILL.md +124 -0
- package/rules/dotnet/razor-pages/references/REFERENCE.md +321 -0
- package/rules/dotnet/security/SKILL.md +89 -0
- package/rules/dotnet/security/references/REFERENCE.md +295 -0
- package/rules/dotnet/tooling/SKILL.md +92 -0
- package/rules/dotnet/tooling/references/REFERENCE.md +300 -0
- package/rules/flutter/auto-route-navigation/SKILL.md +43 -0
- package/rules/flutter/auto-route-navigation/references/REFERENCE.md +19 -0
- package/rules/flutter/auto-route-navigation/references/router-config.md +62 -0
- package/rules/flutter/bloc-state-management/SKILL.md +64 -0
- package/rules/flutter/bloc-state-management/references/REFERENCE.md +20 -0
- package/rules/flutter/bloc-state-management/references/auth-bloc-example.md +52 -0
- package/rules/flutter/bloc-state-management/references/equatable-usage.md +56 -0
- package/rules/flutter/bloc-state-management/references/property-based-state.md +68 -0
- package/rules/flutter/bloc.rule.md +76 -0
- package/rules/flutter/cicd/SKILL.md +48 -0
- package/rules/flutter/cicd/references/advanced-workflow.md +66 -0
- package/rules/flutter/cicd/references/fastlane.md +139 -0
- package/rules/flutter/cicd/references/github-actions.md +59 -0
- package/rules/flutter/dependency-injection/SKILL.md +42 -0
- package/rules/flutter/dependency-injection/references/REFERENCE.md +15 -0
- package/rules/flutter/dependency-injection/references/modules.md +37 -0
- package/rules/flutter/error-handling/SKILL.md +32 -0
- package/rules/flutter/error-handling/references/REFERENCE.md +19 -0
- package/rules/flutter/error-handling/references/error-mapping.md +31 -0
- package/rules/flutter/feature-based-clean-architecture/SKILL.md +46 -0
- package/rules/flutter/feature-based-clean-architecture/references/REFERENCE.md +14 -0
- package/rules/flutter/feature-based-clean-architecture/references/folder-structure.md +36 -0
- package/rules/flutter/getx-navigation/SKILL.md +70 -0
- package/rules/flutter/getx-navigation/references/app-pages.md +40 -0
- package/rules/flutter/getx-navigation/references/middleware-example.md +29 -0
- package/rules/flutter/getx-state-management/SKILL.md +76 -0
- package/rules/flutter/getx-state-management/references/binding-example.md +32 -0
- package/rules/flutter/getx-state-management/references/reactive-vs-simple.md +39 -0
- package/rules/flutter/go-router-navigation/SKILL.md +57 -0
- package/rules/flutter/idiomatic-flutter/SKILL.md +20 -0
- package/rules/flutter/layer-based-clean-architecture/SKILL.md +50 -0
- package/rules/flutter/layer-based-clean-architecture/references/REFERENCE.md +60 -0
- package/rules/flutter/layer-based-clean-architecture/references/repository-mapping.md +50 -0
- package/rules/flutter/localization/SKILL.md +50 -0
- package/rules/flutter/localization/references/REFERENCE.md +48 -0
- package/rules/flutter/localization/references/sheet-loader.md +33 -0
- package/rules/flutter/navigator-v1-navigation/SKILL.md +71 -0
- package/rules/flutter/navigator-v1-navigation/references/on-generate-route.md +48 -0
- package/rules/flutter/performance/SKILL.md +24 -0
- package/rules/flutter/retrofit-networking/SKILL.md +51 -0
- package/rules/flutter/retrofit-networking/references/REFERENCE.md +19 -0
- package/rules/flutter/retrofit-networking/references/token-refresh.md +40 -0
- package/rules/flutter/riverpod-state-management/SKILL.md +53 -0
- package/rules/flutter/riverpod-state-management/references/architecture.md +124 -0
- package/rules/flutter/riverpod-state-management/references/best-practices.md +89 -0
- package/rules/flutter/riverpod-state-management/references/testing.md +73 -0
- package/rules/flutter/riverpod.rule.md +78 -0
- package/rules/flutter/security/SKILL.md +33 -0
- package/rules/flutter/security/references/REFERENCE.md +15 -0
- package/rules/flutter/security/references/network-security.md +28 -0
- package/rules/flutter/testing/SKILL.md +44 -0
- package/rules/flutter/testing/references/REFERENCE.md +21 -0
- package/rules/flutter/testing/references/bloc-testing.md +38 -0
- package/rules/flutter/testing/references/integration-testing.md +128 -0
- package/rules/flutter/testing/references/robot-pattern.md +82 -0
- package/rules/flutter/testing/references/unit-testing.md +130 -0
- package/rules/flutter/testing/references/widget-testing.md +120 -0
- package/rules/flutter/widgets/SKILL.md +37 -0
- package/rules/golang/chi-router/SKILL.md +219 -0
- package/rules/golang/chi-router/references/REFERENCE.md +13 -0
- package/rules/golang/chi-router/references/routing-patterns.md +205 -0
- package/rules/golang/cobra-cli/SKILL.md +227 -0
- package/rules/golang/cobra-cli/references/REFERENCE.md +13 -0
- package/rules/golang/cobra-cli/references/command-patterns.md +224 -0
- package/rules/golang/core/SKILL.md +210 -0
- package/rules/golang/core/references/REFERENCE.md +14 -0
- package/rules/golang/core/references/concurrency-patterns.md +114 -0
- package/rules/golang/core/references/error-handling.md +87 -0
- package/rules/golang/echo-framework/SKILL.md +215 -0
- package/rules/golang/echo-framework/references/REFERENCE.md +14 -0
- package/rules/golang/echo-framework/references/middleware-patterns.md +141 -0
- package/rules/golang/echo-framework/references/routing-patterns.md +140 -0
- package/rules/golang/ent-orm/SKILL.md +239 -0
- package/rules/golang/ent-orm/references/REFERENCE.md +13 -0
- package/rules/golang/ent-orm/references/schema-patterns.md +255 -0
- package/rules/golang/fiber-framework/SKILL.md +196 -0
- package/rules/golang/fiber-framework/references/REFERENCE.md +13 -0
- package/rules/golang/fiber-framework/references/routing-patterns.md +191 -0
- package/rules/golang/gin-framework/SKILL.md +205 -0
- package/rules/golang/gin-framework/references/REFERENCE.md +14 -0
- package/rules/golang/gin-framework/references/middleware-patterns.md +119 -0
- package/rules/golang/gorm-orm/SKILL.md +196 -0
- package/rules/golang/gorm-orm/references/REFERENCE.md +14 -0
- package/rules/golang/gorm-orm/references/model-definitions.md +167 -0
- package/rules/golang/gorm-orm/references/query-patterns.md +161 -0
- package/rules/golang/grpc/SKILL.md +231 -0
- package/rules/golang/grpc/references/REFERENCE.md +13 -0
- package/rules/golang/grpc/references/service-patterns.md +276 -0
- package/rules/golang/testify/SKILL.md +239 -0
- package/rules/golang/testify/references/REFERENCE.md +13 -0
- package/rules/golang/testify/references/assert-patterns.md +170 -0
- package/rules/golang/validator/SKILL.md +234 -0
- package/rules/golang/validator/references/REFERENCE.md +13 -0
- package/rules/golang/validator/references/validation-tags.md +211 -0
- package/rules/golang/viper-config/SKILL.md +244 -0
- package/rules/golang/viper-config/references/REFERENCE.md +13 -0
- package/rules/golang/viper-config/references/config-loading.md +181 -0
- package/rules/golang/wire-di/SKILL.md +243 -0
- package/rules/golang/wire-di/references/REFERENCE.md +13 -0
- package/rules/golang/wire-di/references/provider-patterns.md +193 -0
- package/rules/golang/zap-logging/SKILL.md +203 -0
- package/rules/golang/zap-logging/references/REFERENCE.md +13 -0
- package/rules/golang/zap-logging/references/logger-config.md +165 -0
- package/rules/java/build-gradle/SKILL.md +92 -0
- package/rules/java/build-gradle/references/REFERENCE.md +14 -0
- package/rules/java/build-gradle/references/kotlin-dsl.md +118 -0
- package/rules/java/build-gradle/references/task-configuration.md +132 -0
- package/rules/java/build-maven/SKILL.md +86 -0
- package/rules/java/build-maven/references/REFERENCE.md +14 -0
- package/rules/java/build-maven/references/dependency-management.md +111 -0
- package/rules/java/build-maven/references/lifecycle-phases.md +114 -0
- package/rules/java/graalvm-native/SKILL.md +105 -0
- package/rules/java/graalvm-native/references/REFERENCE.md +12 -0
- package/rules/java/java-collections-streams/SKILL.md +148 -0
- package/rules/java/java-collections-streams/references/REFERENCE.md +15 -0
- package/rules/java/java-collections-streams/references/collectors-patterns.md +178 -0
- package/rules/java/java-collections-streams/references/stream-pipelines.md +165 -0
- package/rules/java/java-concurrency/SKILL.md +187 -0
- package/rules/java/java-concurrency/references/REFERENCE.md +17 -0
- package/rules/java/java-concurrency/references/completable-future.md +165 -0
- package/rules/java/java-concurrency/references/executor-patterns.md +176 -0
- package/rules/java/java-concurrency/references/virtual-threads.md +190 -0
- package/rules/java/java-core-language/SKILL.md +121 -0
- package/rules/java/java-core-language/references/REFERENCE.md +15 -0
- package/rules/java/java-core-language/references/jvm-memory-model.md +160 -0
- package/rules/java/java-core-language/references/modern-java-features.md +168 -0
- package/rules/java/java-project-structure/SKILL.md +195 -0
- package/rules/java/java-project-structure/references/REFERENCE.md +15 -0
- package/rules/java/java-project-structure/references/maven-project-layout.md +199 -0
- package/rules/java/java-project-structure/references/module-system.md +159 -0
- package/rules/java/micronaut-core/SKILL.md +99 -0
- package/rules/java/micronaut-core/references/REFERENCE.md +12 -0
- package/rules/java/micronaut-reactive/SKILL.md +68 -0
- package/rules/java/micronaut-reactive/references/REFERENCE.md +12 -0
- package/rules/java/quarkus-core/SKILL.md +85 -0
- package/rules/java/quarkus-core/references/REFERENCE.md +12 -0
- package/rules/java/quarkus-reactive/SKILL.md +67 -0
- package/rules/java/quarkus-reactive/references/REFERENCE.md +12 -0
- package/rules/java/spring-batch/SKILL.md +102 -0
- package/rules/java/spring-batch/references/REFERENCE.md +12 -0
- package/rules/java/spring-boot-architecture/SKILL.md +206 -0
- package/rules/java/spring-boot-architecture/references/REFERENCE.md +15 -0
- package/rules/java/spring-boot-architecture/references/auto-configuration.md +158 -0
- package/rules/java/spring-boot-architecture/references/configuration-properties.md +202 -0
- package/rules/java/spring-boot-web/SKILL.md +217 -0
- package/rules/java/spring-boot-web/references/REFERENCE.md +17 -0
- package/rules/java/spring-cloud/SKILL.md +109 -0
- package/rules/java/spring-cloud/references/REFERENCE.md +13 -0
- package/rules/java/spring-data-jpa/SKILL.md +241 -0
- package/rules/java/spring-data-jpa/references/REFERENCE.md +16 -0
- package/rules/java/spring-security/SKILL.md +161 -0
- package/rules/java/spring-security/references/REFERENCE.md +16 -0
- package/rules/java/spring-security/references/jwt-auth-flow.md +213 -0
- package/rules/java/testing-junit-mockito/SKILL.md +135 -0
- package/rules/java/testing-junit-mockito/references/REFERENCE.md +15 -0
- package/rules/java/testing-junit-mockito/references/junit5-patterns.md +159 -0
- package/rules/java/testing-junit-mockito/references/mockito-patterns.md +148 -0
- package/rules/java/testing-junit-mockito/references/spring-boot-testing.md +152 -0
- package/rules/javascript/best-practices/SKILL.md +64 -0
- package/rules/javascript/best-practices/references/REFERENCE.md +91 -0
- package/rules/javascript/language/SKILL.md +71 -0
- package/rules/javascript/language/references/REFERENCE.md +106 -0
- package/rules/javascript/tooling/SKILL.md +60 -0
- package/rules/javascript/tooling/references/REFERENCE.md +107 -0
- package/rules/metadata.json +54 -0
- package/rules/nestjs/api-standards/SKILL.md +47 -0
- package/rules/nestjs/api-standards/references/pagination-wrapper.md +87 -0
- package/rules/nestjs/architecture/SKILL.md +68 -0
- package/rules/nestjs/architecture/references/dynamic-module.md +53 -0
- package/rules/nestjs/caching/SKILL.md +51 -0
- package/rules/nestjs/caching/references/REFERENCE.md +13 -0
- package/rules/nestjs/caching/references/cache-patterns.md +183 -0
- package/rules/nestjs/configuration/SKILL.md +41 -0
- package/rules/nestjs/configuration/references/REFERENCE.md +13 -0
- package/rules/nestjs/configuration/references/config-patterns.md +184 -0
- package/rules/nestjs/controllers-services/SKILL.md +63 -0
- package/rules/nestjs/controllers-services/references/REFERENCE.md +14 -0
- package/rules/nestjs/controllers-services/references/controller-patterns.md +119 -0
- package/rules/nestjs/controllers-services/references/service-patterns.md +129 -0
- package/rules/nestjs/database/SKILL.md +102 -0
- package/rules/nestjs/database/references/REFERENCE.md +14 -0
- package/rules/nestjs/database/references/typeorm-patterns.md +156 -0
- package/rules/nestjs/deployment/SKILL.md +36 -0
- package/rules/nestjs/deployment/references/REFERENCE.md +13 -0
- package/rules/nestjs/deployment/references/deployment-patterns.md +140 -0
- package/rules/nestjs/documentation/SKILL.md +64 -0
- package/rules/nestjs/documentation/references/REFERENCE.md +13 -0
- package/rules/nestjs/documentation/references/swagger-patterns.md +139 -0
- package/rules/nestjs/error-handling/SKILL.md +55 -0
- package/rules/nestjs/error-handling/references/REFERENCE.md +13 -0
- package/rules/nestjs/error-handling/references/exception-filters.md +152 -0
- package/rules/nestjs/file-uploads/SKILL.md +35 -0
- package/rules/nestjs/file-uploads/references/REFERENCE.md +13 -0
- package/rules/nestjs/file-uploads/references/upload-patterns.md +125 -0
- package/rules/nestjs/observability/SKILL.md +39 -0
- package/rules/nestjs/observability/references/REFERENCE.md +13 -0
- package/rules/nestjs/observability/references/logging-metrics.md +175 -0
- package/rules/nestjs/performance/SKILL.md +60 -0
- package/rules/nestjs/performance/references/REFERENCE.md +13 -0
- package/rules/nestjs/performance/references/performance-patterns.md +107 -0
- package/rules/nestjs/real-time/SKILL.md +45 -0
- package/rules/nestjs/real-time/references/REFERENCE.md +13 -0
- package/rules/nestjs/real-time/references/websocket-patterns.md +121 -0
- package/rules/nestjs/scheduling/SKILL.md +39 -0
- package/rules/nestjs/scheduling/references/REFERENCE.md +13 -0
- package/rules/nestjs/scheduling/references/scheduling-patterns.md +137 -0
- package/rules/nestjs/search/SKILL.md +41 -0
- package/rules/nestjs/search/references/REFERENCE.md +13 -0
- package/rules/nestjs/search/references/search-patterns.md +137 -0
- package/rules/nestjs/security/SKILL.md +87 -0
- package/rules/nestjs/security/references/REFERENCE.md +14 -0
- package/rules/nestjs/security/references/authentication.md +151 -0
- package/rules/nestjs/testing/SKILL.md +40 -0
- package/rules/nestjs/testing/references/REFERENCE.md +14 -0
- package/rules/nestjs/testing/references/unit-testing.md +179 -0
- package/rules/nestjs/transport/SKILL.md +45 -0
- package/rules/nestjs/transport/references/REFERENCE.md +13 -0
- package/rules/nestjs/transport/references/microservices-patterns.md +170 -0
- package/rules/nextjs/app-router/SKILL.md +46 -0
- package/rules/nextjs/app-router/references/REFERENCE.md +14 -0
- package/rules/nextjs/app-router/references/routing-patterns.md +182 -0
- package/rules/nextjs/architecture/SKILL.md +44 -0
- package/rules/nextjs/architecture/references/fsd-structure.md +77 -0
- package/rules/nextjs/authentication/SKILL.md +29 -0
- package/rules/nextjs/authentication/references/auth-implementation.md +73 -0
- package/rules/nextjs/caching/SKILL.md +66 -0
- package/rules/nextjs/caching/references/REFERENCE.md +13 -0
- package/rules/nextjs/caching/references/cache-strategies.md +168 -0
- package/rules/nextjs/data-access-layer/SKILL.md +33 -0
- package/rules/nextjs/data-access-layer/references/patterns.md +66 -0
- package/rules/nextjs/data-fetching/SKILL.md +59 -0
- package/rules/nextjs/data-fetching/references/REFERENCE.md +13 -0
- package/rules/nextjs/data-fetching/references/fetch-patterns.md +160 -0
- package/rules/nextjs/internationalization/SKILL.md +105 -0
- package/rules/nextjs/internationalization/references/REFERENCE.md +13 -0
- package/rules/nextjs/internationalization/references/i18n-patterns.md +180 -0
- package/rules/nextjs/optimization/SKILL.md +64 -0
- package/rules/nextjs/optimization/references/REFERENCE.md +13 -0
- package/rules/nextjs/optimization/references/optimization-patterns.md +190 -0
- package/rules/nextjs/rendering/SKILL.md +91 -0
- package/rules/nextjs/rendering/references/REFERENCE.md +13 -0
- package/rules/nextjs/rendering/references/rendering-modes.md +163 -0
- package/rules/nextjs/server-actions/SKILL.md +46 -0
- package/rules/nextjs/server-actions/references/REFERENCE.md +13 -0
- package/rules/nextjs/server-actions/references/action-patterns.md +188 -0
- package/rules/nextjs/server-components/SKILL.md +52 -0
- package/rules/nextjs/server-components/references/REFERENCE.md +13 -0
- package/rules/nextjs/server-components/references/component-patterns.md +175 -0
- package/rules/nextjs/state-management/SKILL.md +73 -0
- package/rules/nextjs/state-management/references/REFERENCE.md +13 -0
- package/rules/nextjs/state-management/references/state-patterns.md +218 -0
- package/rules/nextjs/styling/SKILL.md +31 -0
- package/rules/nextjs/styling/references/implementation.md +56 -0
- package/rules/react/component-patterns/SKILL.md +66 -0
- package/rules/react/component-patterns/references/REFERENCE.md +126 -0
- package/rules/react/hooks/SKILL.md +60 -0
- package/rules/react/hooks/references/REFERENCE.md +132 -0
- package/rules/react/hooks.rule.md +79 -0
- package/rules/react/performance/SKILL.md +69 -0
- package/rules/react/performance/references/REFERENCE.md +143 -0
- package/rules/react/security/SKILL.md +46 -0
- package/rules/react/security/references/REFERENCE.md +170 -0
- package/rules/react/state-management/SKILL.md +56 -0
- package/rules/react/state-management/references/REFERENCE.md +137 -0
- package/rules/react/testing/SKILL.md +45 -0
- package/rules/react/testing/references/REFERENCE.md +149 -0
- package/rules/react/tooling/SKILL.md +39 -0
- package/rules/react/typescript/SKILL.md +53 -0
- package/rules/rust/actix-web/SKILL.md +160 -0
- package/rules/rust/actix-web/references/REFERENCE.md +13 -0
- package/rules/rust/actix-web/references/handler-patterns.md +198 -0
- package/rules/rust/async-graphql/SKILL.md +228 -0
- package/rules/rust/async-graphql/references/REFERENCE.md +13 -0
- package/rules/rust/async-graphql/references/schema-patterns.md +215 -0
- package/rules/rust/axum/SKILL.md +161 -0
- package/rules/rust/axum/references/REFERENCE.md +14 -0
- package/rules/rust/axum/references/handler-patterns.md +97 -0
- package/rules/rust/bevy/SKILL.md +206 -0
- package/rules/rust/bevy/references/REFERENCE.md +13 -0
- package/rules/rust/bevy/references/ecs-patterns.md +226 -0
- package/rules/rust/clap/SKILL.md +217 -0
- package/rules/rust/clap/references/REFERENCE.md +13 -0
- package/rules/rust/clap/references/derive-patterns.md +205 -0
- package/rules/rust/core/SKILL.md +154 -0
- package/rules/rust/core/references/REFERENCE.md +14 -0
- package/rules/rust/core/references/error-handling.md +92 -0
- package/rules/rust/diesel-orm/SKILL.md +176 -0
- package/rules/rust/diesel-orm/references/REFERENCE.md +13 -0
- package/rules/rust/diesel-orm/references/schema-patterns.md +206 -0
- package/rules/rust/rocket/SKILL.md +182 -0
- package/rules/rust/rocket/references/REFERENCE.md +13 -0
- package/rules/rust/rocket/references/handler-patterns.md +209 -0
- package/rules/rust/sea-orm/SKILL.md +230 -0
- package/rules/rust/sea-orm/references/REFERENCE.md +13 -0
- package/rules/rust/sea-orm/references/entity-patterns.md +221 -0
- package/rules/rust/serde-serialization/SKILL.md +150 -0
- package/rules/rust/serde-serialization/references/REFERENCE.md +13 -0
- package/rules/rust/serde-serialization/references/serialization-patterns.md +199 -0
- package/rules/rust/sqlx-database/SKILL.md +140 -0
- package/rules/rust/sqlx-database/references/REFERENCE.md +13 -0
- package/rules/rust/sqlx-database/references/query-patterns.md +210 -0
- package/rules/rust/tauri/SKILL.md +180 -0
- package/rules/rust/tauri/references/REFERENCE.md +13 -0
- package/rules/rust/tauri/references/command-patterns.md +209 -0
- package/rules/rust/tokio-runtime/SKILL.md +167 -0
- package/rules/rust/tokio-runtime/references/REFERENCE.md +14 -0
- package/rules/rust/tokio-runtime/references/async-patterns.md +137 -0
- package/rules/rust/tokio-runtime/references/synchronization.md +152 -0
- package/rules/rust/tonic/SKILL.md +231 -0
- package/rules/rust/tonic/references/REFERENCE.md +13 -0
- package/rules/rust/tonic/references/service-patterns.md +213 -0
- package/rules/rust/tracing/SKILL.md +214 -0
- package/rules/rust/tracing/references/REFERENCE.md +13 -0
- package/rules/rust/tracing/references/instrumentation.md +187 -0
- package/rules/typescript/best-practices/SKILL.md +108 -0
- package/rules/typescript/best-practices/references/REFERENCE.md +68 -0
- package/rules/typescript/language/SKILL.md +72 -0
- package/rules/typescript/language/references/REFERENCE.md +67 -0
- package/rules/typescript/patterns.rule.md +85 -0
- package/rules/typescript/security/SKILL.md +59 -0
- package/rules/typescript/security/references/REFERENCE.md +113 -0
- package/rules/typescript/tooling/SKILL.md +52 -0
- package/rules/typescript/tooling/references/REFERENCE.md +110 -0
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# Fiber Routing Patterns
|
|
2
|
+
|
|
3
|
+
## Basic Setup
|
|
4
|
+
|
|
5
|
+
```go
|
|
6
|
+
import "github.com/gofiber/fiber/v2"
|
|
7
|
+
|
|
8
|
+
func main() {
|
|
9
|
+
app := fiber.New(fiber.Config{
|
|
10
|
+
Prefork: false,
|
|
11
|
+
CaseSensitive: true,
|
|
12
|
+
StrictRouting: true,
|
|
13
|
+
ServerHeader: "MyApp",
|
|
14
|
+
AppName: "My App v1.0.0",
|
|
15
|
+
})
|
|
16
|
+
|
|
17
|
+
// Basic routes
|
|
18
|
+
app.Get("/", func(c *fiber.Ctx) error {
|
|
19
|
+
return c.SendString("Hello, World!")
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
app.Post("/users", createUser)
|
|
23
|
+
app.Get("/users/:id", getUser)
|
|
24
|
+
app.Put("/users/:id", updateUser)
|
|
25
|
+
app.Delete("/users/:id", deleteUser)
|
|
26
|
+
|
|
27
|
+
app.Listen(":3000")
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Handlers
|
|
32
|
+
|
|
33
|
+
```go
|
|
34
|
+
// Path parameters
|
|
35
|
+
func getUser(c *fiber.Ctx) error {
|
|
36
|
+
id := c.Params("id")
|
|
37
|
+
return c.JSON(fiber.Map{"id": id})
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
// Query parameters
|
|
41
|
+
func listUsers(c *fiber.Ctx) error {
|
|
42
|
+
page := c.QueryInt("page", 1)
|
|
43
|
+
limit := c.QueryInt("limit", 10)
|
|
44
|
+
search := c.Query("search", "")
|
|
45
|
+
|
|
46
|
+
return c.JSON(fiber.Map{
|
|
47
|
+
"page": page,
|
|
48
|
+
"limit": limit,
|
|
49
|
+
"search": search,
|
|
50
|
+
})
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// Request body
|
|
54
|
+
type CreateUserRequest struct {
|
|
55
|
+
Name string `json:"name" validate:"required"`
|
|
56
|
+
Email string `json:"email" validate:"required,email"`
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
func createUser(c *fiber.Ctx) error {
|
|
60
|
+
req := new(CreateUserRequest)
|
|
61
|
+
if err := c.BodyParser(req); err != nil {
|
|
62
|
+
return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
|
|
63
|
+
"error": err.Error(),
|
|
64
|
+
})
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
return c.Status(fiber.StatusCreated).JSON(req)
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// Headers
|
|
71
|
+
func handler(c *fiber.Ctx) error {
|
|
72
|
+
auth := c.Get("Authorization")
|
|
73
|
+
c.Set("X-Custom-Header", "value")
|
|
74
|
+
return c.SendString("OK")
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Route Groups
|
|
79
|
+
|
|
80
|
+
```go
|
|
81
|
+
func main() {
|
|
82
|
+
app := fiber.New()
|
|
83
|
+
|
|
84
|
+
// API group
|
|
85
|
+
api := app.Group("/api")
|
|
86
|
+
|
|
87
|
+
// Version groups
|
|
88
|
+
v1 := api.Group("/v1")
|
|
89
|
+
v1.Get("/users", listUsersV1)
|
|
90
|
+
|
|
91
|
+
v2 := api.Group("/v2")
|
|
92
|
+
v2.Get("/users", listUsersV2)
|
|
93
|
+
|
|
94
|
+
// Group with middleware
|
|
95
|
+
admin := api.Group("/admin", authMiddleware)
|
|
96
|
+
admin.Get("/stats", getStats)
|
|
97
|
+
admin.Post("/config", updateConfig)
|
|
98
|
+
|
|
99
|
+
app.Listen(":3000")
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Middleware
|
|
104
|
+
|
|
105
|
+
```go
|
|
106
|
+
import (
|
|
107
|
+
"github.com/gofiber/fiber/v2"
|
|
108
|
+
"github.com/gofiber/fiber/v2/middleware/logger"
|
|
109
|
+
"github.com/gofiber/fiber/v2/middleware/recover"
|
|
110
|
+
"github.com/gofiber/fiber/v2/middleware/cors"
|
|
111
|
+
"github.com/gofiber/fiber/v2/middleware/limiter"
|
|
112
|
+
)
|
|
113
|
+
|
|
114
|
+
func main() {
|
|
115
|
+
app := fiber.New()
|
|
116
|
+
|
|
117
|
+
// Built-in middleware
|
|
118
|
+
app.Use(recover.New())
|
|
119
|
+
app.Use(logger.New())
|
|
120
|
+
app.Use(cors.New(cors.Config{
|
|
121
|
+
AllowOrigins: "https://example.com",
|
|
122
|
+
AllowMethods: "GET,POST,PUT,DELETE",
|
|
123
|
+
}))
|
|
124
|
+
|
|
125
|
+
// Rate limiter
|
|
126
|
+
app.Use(limiter.New(limiter.Config{
|
|
127
|
+
Max: 100,
|
|
128
|
+
Expiration: 1 * time.Minute,
|
|
129
|
+
}))
|
|
130
|
+
|
|
131
|
+
// Custom middleware
|
|
132
|
+
app.Use(func(c *fiber.Ctx) error {
|
|
133
|
+
start := time.Now()
|
|
134
|
+
|
|
135
|
+
err := c.Next()
|
|
136
|
+
|
|
137
|
+
duration := time.Since(start)
|
|
138
|
+
c.Set("X-Response-Time", duration.String())
|
|
139
|
+
|
|
140
|
+
return err
|
|
141
|
+
})
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Error Handling
|
|
146
|
+
|
|
147
|
+
```go
|
|
148
|
+
func main() {
|
|
149
|
+
app := fiber.New(fiber.Config{
|
|
150
|
+
ErrorHandler: func(c *fiber.Ctx, err error) error {
|
|
151
|
+
code := fiber.StatusInternalServerError
|
|
152
|
+
|
|
153
|
+
if e, ok := err.(*fiber.Error); ok {
|
|
154
|
+
code = e.Code
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
return c.Status(code).JSON(fiber.Map{
|
|
158
|
+
"error": err.Error(),
|
|
159
|
+
})
|
|
160
|
+
},
|
|
161
|
+
})
|
|
162
|
+
|
|
163
|
+
app.Get("/user/:id", func(c *fiber.Ctx) error {
|
|
164
|
+
id := c.Params("id")
|
|
165
|
+
user, err := findUser(id)
|
|
166
|
+
if err != nil {
|
|
167
|
+
return fiber.NewError(fiber.StatusNotFound, "User not found")
|
|
168
|
+
}
|
|
169
|
+
return c.JSON(user)
|
|
170
|
+
})
|
|
171
|
+
}
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## Static Files and Templates
|
|
175
|
+
|
|
176
|
+
```go
|
|
177
|
+
// Static files
|
|
178
|
+
app.Static("/", "./public")
|
|
179
|
+
app.Static("/static", "./assets")
|
|
180
|
+
|
|
181
|
+
// Templates
|
|
182
|
+
app := fiber.New(fiber.Config{
|
|
183
|
+
Views: html.New("./views", ".html"),
|
|
184
|
+
})
|
|
185
|
+
|
|
186
|
+
app.Get("/", func(c *fiber.Ctx) error {
|
|
187
|
+
return c.Render("index", fiber.Map{
|
|
188
|
+
"Title": "Hello, World!",
|
|
189
|
+
})
|
|
190
|
+
})
|
|
191
|
+
```
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Gin Framework
|
|
3
|
+
description: High-performance Go web framework with martini-like API.
|
|
4
|
+
metadata:
|
|
5
|
+
labels: [golang, gin, web, framework]
|
|
6
|
+
triggers:
|
|
7
|
+
files: ['**/main.go', '**/routes.go']
|
|
8
|
+
keywords: [gin, gin.Default, gin.Engine, c.JSON]
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Gin Framework Standards
|
|
12
|
+
|
|
13
|
+
## Router Setup
|
|
14
|
+
|
|
15
|
+
```go
|
|
16
|
+
package main
|
|
17
|
+
|
|
18
|
+
import (
|
|
19
|
+
"github.com/gin-gonic/gin"
|
|
20
|
+
)
|
|
21
|
+
|
|
22
|
+
func main() {
|
|
23
|
+
r := gin.Default() // Includes Logger and Recovery middleware
|
|
24
|
+
|
|
25
|
+
// Routes
|
|
26
|
+
r.GET("/ping", pingHandler)
|
|
27
|
+
r.POST("/users", createUser)
|
|
28
|
+
|
|
29
|
+
// Route groups
|
|
30
|
+
api := r.Group("/api/v1")
|
|
31
|
+
{
|
|
32
|
+
api.GET("/users", listUsers)
|
|
33
|
+
api.GET("/users/:id", getUser)
|
|
34
|
+
api.PUT("/users/:id", updateUser)
|
|
35
|
+
api.DELETE("/users/:id", deleteUser)
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
r.Run(":8080")
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Handlers
|
|
43
|
+
|
|
44
|
+
```go
|
|
45
|
+
// Path parameters
|
|
46
|
+
func getUser(c *gin.Context) {
|
|
47
|
+
id := c.Param("id")
|
|
48
|
+
user, err := findUser(id)
|
|
49
|
+
if err != nil {
|
|
50
|
+
c.JSON(404, gin.H{"error": "User not found"})
|
|
51
|
+
return
|
|
52
|
+
}
|
|
53
|
+
c.JSON(200, user)
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// Query parameters
|
|
57
|
+
func listUsers(c *gin.Context) {
|
|
58
|
+
page := c.DefaultQuery("page", "1")
|
|
59
|
+
limit := c.DefaultQuery("limit", "10")
|
|
60
|
+
users := fetchUsers(page, limit)
|
|
61
|
+
c.JSON(200, users)
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
// JSON body binding
|
|
65
|
+
type CreateUserRequest struct {
|
|
66
|
+
Name string `json:"name" binding:"required"`
|
|
67
|
+
Email string `json:"email" binding:"required,email"`
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
func createUser(c *gin.Context) {
|
|
71
|
+
var req CreateUserRequest
|
|
72
|
+
if err := c.ShouldBindJSON(&req); err != nil {
|
|
73
|
+
c.JSON(400, gin.H{"error": err.Error()})
|
|
74
|
+
return
|
|
75
|
+
}
|
|
76
|
+
user := insertUser(req)
|
|
77
|
+
c.JSON(201, user)
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Binding & Validation
|
|
82
|
+
|
|
83
|
+
```go
|
|
84
|
+
type LoginRequest struct {
|
|
85
|
+
Username string `json:"username" binding:"required,min=3,max=50"`
|
|
86
|
+
Password string `json:"password" binding:"required,min=8"`
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// Custom validation
|
|
90
|
+
type BookingRequest struct {
|
|
91
|
+
CheckIn time.Time `json:"check_in" binding:"required"`
|
|
92
|
+
CheckOut time.Time `json:"check_out" binding:"required,gtfield=CheckIn"`
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Bind from different sources
|
|
96
|
+
c.ShouldBindJSON(&obj) // JSON body
|
|
97
|
+
c.ShouldBindQuery(&obj) // Query string
|
|
98
|
+
c.ShouldBind(&obj) // Auto-detect
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Middleware
|
|
102
|
+
|
|
103
|
+
```go
|
|
104
|
+
// Global middleware
|
|
105
|
+
r := gin.New()
|
|
106
|
+
r.Use(gin.Logger())
|
|
107
|
+
r.Use(gin.Recovery())
|
|
108
|
+
r.Use(corsMiddleware())
|
|
109
|
+
|
|
110
|
+
// Group middleware
|
|
111
|
+
authorized := r.Group("/admin")
|
|
112
|
+
authorized.Use(authMiddleware())
|
|
113
|
+
|
|
114
|
+
// Custom middleware
|
|
115
|
+
func authMiddleware() gin.HandlerFunc {
|
|
116
|
+
return func(c *gin.Context) {
|
|
117
|
+
token := c.GetHeader("Authorization")
|
|
118
|
+
if token == "" {
|
|
119
|
+
c.AbortWithStatusJSON(401, gin.H{"error": "Unauthorized"})
|
|
120
|
+
return
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
user, err := validateToken(token)
|
|
124
|
+
if err != nil {
|
|
125
|
+
c.AbortWithStatusJSON(401, gin.H{"error": "Invalid token"})
|
|
126
|
+
return
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
c.Set("user", user)
|
|
130
|
+
c.Next()
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
// Access middleware data
|
|
135
|
+
func handler(c *gin.Context) {
|
|
136
|
+
user, _ := c.Get("user")
|
|
137
|
+
// use user
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Error Handling
|
|
142
|
+
|
|
143
|
+
```go
|
|
144
|
+
// Centralized error handling
|
|
145
|
+
type AppError struct {
|
|
146
|
+
Code int `json:"code"`
|
|
147
|
+
Message string `json:"message"`
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
func errorMiddleware() gin.HandlerFunc {
|
|
151
|
+
return func(c *gin.Context) {
|
|
152
|
+
c.Next()
|
|
153
|
+
|
|
154
|
+
if len(c.Errors) > 0 {
|
|
155
|
+
err := c.Errors.Last()
|
|
156
|
+
switch e := err.Err.(type) {
|
|
157
|
+
case *AppError:
|
|
158
|
+
c.JSON(e.Code, e)
|
|
159
|
+
default:
|
|
160
|
+
c.JSON(500, gin.H{"error": "Internal server error"})
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
// In handler
|
|
167
|
+
func handler(c *gin.Context) {
|
|
168
|
+
if err := doSomething(); err != nil {
|
|
169
|
+
c.Error(&AppError{Code: 400, Message: err.Error()})
|
|
170
|
+
return
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
## Dependency Injection
|
|
176
|
+
|
|
177
|
+
```go
|
|
178
|
+
type Handler struct {
|
|
179
|
+
db *sql.DB
|
|
180
|
+
cache *redis.Client
|
|
181
|
+
logger *zap.Logger
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
func NewHandler(db *sql.DB, cache *redis.Client, logger *zap.Logger) *Handler {
|
|
185
|
+
return &Handler{db: db, cache: cache, logger: logger}
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
func (h *Handler) GetUser(c *gin.Context) {
|
|
189
|
+
user, err := h.db.FindUser(c.Param("id"))
|
|
190
|
+
// ...
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
// Setup routes
|
|
194
|
+
func SetupRoutes(r *gin.Engine, h *Handler) {
|
|
195
|
+
r.GET("/users/:id", h.GetUser)
|
|
196
|
+
}
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## Best Practices
|
|
200
|
+
|
|
201
|
+
1. **Gin modes**: Use `gin.SetMode(gin.ReleaseMode)` in production
|
|
202
|
+
2. **Graceful shutdown**: Implement with `http.Server` and context
|
|
203
|
+
3. **Validation**: Use struct tags for input validation
|
|
204
|
+
4. **Logging**: Replace default logger with structured logging (zap/zerolog)
|
|
205
|
+
5. **Testing**: Use `httptest` with gin test mode
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Gin Framework References
|
|
2
|
+
|
|
3
|
+
## References
|
|
4
|
+
|
|
5
|
+
- [**Middleware Patterns**](middleware-patterns.md) - Auth, logging, recovery, CORS
|
|
6
|
+
- [**Handler Patterns**](handler-patterns.md) - Request handling, validation, responses
|
|
7
|
+
|
|
8
|
+
## Quick Checks
|
|
9
|
+
|
|
10
|
+
- [ ] Use middleware for cross-cutting concerns
|
|
11
|
+
- [ ] Validate input with binding tags
|
|
12
|
+
- [ ] Consistent error response format
|
|
13
|
+
- [ ] Group routes logically
|
|
14
|
+
- [ ] Use gin.Context for request lifecycle
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Middleware Patterns
|
|
2
|
+
|
|
3
|
+
## Authentication Middleware
|
|
4
|
+
|
|
5
|
+
```go
|
|
6
|
+
func AuthMiddleware(jwtService *JWTService) gin.HandlerFunc {
|
|
7
|
+
return func(c *gin.Context) {
|
|
8
|
+
authHeader := c.GetHeader("Authorization")
|
|
9
|
+
if authHeader == "" {
|
|
10
|
+
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
|
11
|
+
"error": "missing authorization header",
|
|
12
|
+
})
|
|
13
|
+
return
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
tokenString := strings.TrimPrefix(authHeader, "Bearer ")
|
|
17
|
+
claims, err := jwtService.ValidateToken(tokenString)
|
|
18
|
+
if err != nil {
|
|
19
|
+
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
|
20
|
+
"error": "invalid token",
|
|
21
|
+
})
|
|
22
|
+
return
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
c.Set("user_id", claims.UserID)
|
|
26
|
+
c.Set("user_role", claims.Role)
|
|
27
|
+
c.Next()
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
// Usage
|
|
32
|
+
api := r.Group("/api")
|
|
33
|
+
api.Use(AuthMiddleware(jwtService))
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Logging Middleware
|
|
37
|
+
|
|
38
|
+
```go
|
|
39
|
+
func LoggingMiddleware(logger *zap.Logger) gin.HandlerFunc {
|
|
40
|
+
return func(c *gin.Context) {
|
|
41
|
+
start := time.Now()
|
|
42
|
+
path := c.Request.URL.Path
|
|
43
|
+
query := c.Request.URL.RawQuery
|
|
44
|
+
|
|
45
|
+
c.Next()
|
|
46
|
+
|
|
47
|
+
latency := time.Since(start)
|
|
48
|
+
status := c.Writer.Status()
|
|
49
|
+
|
|
50
|
+
logger.Info("request",
|
|
51
|
+
zap.String("method", c.Request.Method),
|
|
52
|
+
zap.String("path", path),
|
|
53
|
+
zap.String("query", query),
|
|
54
|
+
zap.Int("status", status),
|
|
55
|
+
zap.Duration("latency", latency),
|
|
56
|
+
zap.String("client_ip", c.ClientIP()),
|
|
57
|
+
)
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Recovery Middleware
|
|
63
|
+
|
|
64
|
+
```go
|
|
65
|
+
func RecoveryMiddleware(logger *zap.Logger) gin.HandlerFunc {
|
|
66
|
+
return func(c *gin.Context) {
|
|
67
|
+
defer func() {
|
|
68
|
+
if err := recover(); err != nil {
|
|
69
|
+
logger.Error("panic recovered",
|
|
70
|
+
zap.Any("error", err),
|
|
71
|
+
zap.String("stack", string(debug.Stack())),
|
|
72
|
+
)
|
|
73
|
+
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{
|
|
74
|
+
"error": "internal server error",
|
|
75
|
+
})
|
|
76
|
+
}
|
|
77
|
+
}()
|
|
78
|
+
c.Next()
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## CORS Middleware
|
|
84
|
+
|
|
85
|
+
```go
|
|
86
|
+
func CORSMiddleware() gin.HandlerFunc {
|
|
87
|
+
return func(c *gin.Context) {
|
|
88
|
+
c.Header("Access-Control-Allow-Origin", "*")
|
|
89
|
+
c.Header("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
|
|
90
|
+
c.Header("Access-Control-Allow-Headers", "Origin, Content-Type, Authorization")
|
|
91
|
+
c.Header("Access-Control-Max-Age", "86400")
|
|
92
|
+
|
|
93
|
+
if c.Request.Method == "OPTIONS" {
|
|
94
|
+
c.AbortWithStatus(http.StatusNoContent)
|
|
95
|
+
return
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
c.Next()
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Rate Limiting
|
|
104
|
+
|
|
105
|
+
```go
|
|
106
|
+
func RateLimitMiddleware(rps int) gin.HandlerFunc {
|
|
107
|
+
limiter := rate.NewLimiter(rate.Limit(rps), rps)
|
|
108
|
+
|
|
109
|
+
return func(c *gin.Context) {
|
|
110
|
+
if !limiter.Allow() {
|
|
111
|
+
c.AbortWithStatusJSON(http.StatusTooManyRequests, gin.H{
|
|
112
|
+
"error": "rate limit exceeded",
|
|
113
|
+
})
|
|
114
|
+
return
|
|
115
|
+
}
|
|
116
|
+
c.Next()
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
```
|