From a4199f0575088644d464533aac6d60302cd3fae5 Mon Sep 17 00:00:00 2001 From: Acbox Date: Wed, 11 Feb 2026 15:29:26 +0800 Subject: [PATCH] chore: move swagger docs to spec --- internal/handlers/swagger.go | 4 ++-- openapi-ts.config.ts | 2 +- docs/docs.go => spec/spec.go | 4 ++-- {docs => spec}/swagger.json | 0 {docs => spec}/swagger.yaml | 0 5 files changed, 5 insertions(+), 5 deletions(-) rename docs/docs.go => spec/spec.go (99%) rename {docs => spec}/swagger.json (100%) rename {docs => spec}/swagger.yaml (100%) diff --git a/internal/handlers/swagger.go b/internal/handlers/swagger.go index 2900ae1a..4d4dec89 100644 --- a/internal/handlers/swagger.go +++ b/internal/handlers/swagger.go @@ -12,7 +12,7 @@ import ( "github.com/labstack/echo/v4" ) -//go:generate go run github.com/swaggo/swag/cmd/swag@latest init -g swagger.go -o ../../docs --parseDependency --parseInternal +//go:generate go run github.com/swaggo/swag/cmd/swag@latest init -g swagger.go -o ../../spec --parseDependency --parseInternal var ( swaggerSpec []byte @@ -36,7 +36,7 @@ func (h *SwaggerHandler) Register(e *echo.Echo) { func (h *SwaggerHandler) Spec(c echo.Context) error { swaggerOnce.Do(func() { - swaggerSpec, swaggerErr = os.ReadFile("docs/swagger.json") + swaggerSpec, swaggerErr = os.ReadFile("spec/swagger.json") }) if swaggerErr != nil { return echo.NewHTTPError(http.StatusInternalServerError, swaggerErr.Error()) diff --git a/openapi-ts.config.ts b/openapi-ts.config.ts index 836c0519..22186f88 100644 --- a/openapi-ts.config.ts +++ b/openapi-ts.config.ts @@ -1,7 +1,7 @@ import { defineConfig } from '@hey-api/openapi-ts'; export default defineConfig({ - input: './docs/swagger.json', + input: './spec/swagger.json', output: 'packages/sdk/src', plugins: [ '@hey-api/typescript', diff --git a/docs/docs.go b/spec/spec.go similarity index 99% rename from docs/docs.go rename to spec/spec.go index 12b6793d..7f9c3cf5 100644 --- a/docs/docs.go +++ b/spec/spec.go @@ -1,5 +1,5 @@ -// Package docs Code generated by swaggo/swag. DO NOT EDIT -package docs +// Package spec Code generated by swaggo/swag. DO NOT EDIT +package spec import "github.com/swaggo/swag" diff --git a/docs/swagger.json b/spec/swagger.json similarity index 100% rename from docs/swagger.json rename to spec/swagger.json diff --git a/docs/swagger.yaml b/spec/swagger.yaml similarity index 100% rename from docs/swagger.yaml rename to spec/swagger.yaml