✨ refactor: convert all DanceLessonsCoach mentions to kebab-case
This commit is contained in:
@@ -9,7 +9,7 @@
|
||||
|
||||
## Context
|
||||
|
||||
The DanceLessonsCoach project requires comprehensive API documentation and testing capabilities. As the API evolves with v1 and v2 endpoints, we need a robust OpenAPI/Swagger toolchain to:
|
||||
The dance-lessons-coach project requires comprehensive API documentation and testing capabilities. As the API evolves with v1 and v2 endpoints, we need a robust OpenAPI/Swagger toolchain to:
|
||||
|
||||
1. **Document APIs**: Generate interactive API documentation
|
||||
2. **Test APIs**: Enable automated API testing
|
||||
@@ -166,9 +166,9 @@ import (
|
||||
// Chi adapter would be needed
|
||||
)
|
||||
|
||||
// @title DanceLessonsCoach API
|
||||
// @title dance-lessons-coach API
|
||||
// @version 1.0
|
||||
// @description API for DanceLessonsCoach service
|
||||
// @description API for dance-lessons-coach service
|
||||
// @host localhost:8080
|
||||
// @BasePath /api
|
||||
func main() {
|
||||
@@ -328,9 +328,9 @@ After thorough evaluation and implementation, we've successfully integrated swag
|
||||
go install github.com/swaggo/swag/cmd/swag@latest
|
||||
|
||||
# 2. Add swagger metadata to main.go
|
||||
// @title DanceLessonsCoach API
|
||||
// @title dance-lessons-coach API
|
||||
// @version 1.0
|
||||
// @description API for DanceLessonsCoach service
|
||||
// @description API for dance-lessons-coach service
|
||||
// @host localhost:8080
|
||||
// @BasePath /api
|
||||
package main
|
||||
@@ -390,9 +390,9 @@ swag fmt
|
||||
go install github.com/swaggo/swag/cmd/swag@latest
|
||||
|
||||
# 2. Add swagger metadata to main.go
|
||||
// @title DanceLessonsCoach API
|
||||
// @title dance-lessons-coach API
|
||||
// @version 1.0
|
||||
// @description API for DanceLessonsCoach service
|
||||
// @description API for dance-lessons-coach service
|
||||
// @host localhost:8080
|
||||
// @BasePath /api
|
||||
package main
|
||||
@@ -525,7 +525,7 @@ s.router.Get("/swagger/*", httpSwagger.WrapHandler)
|
||||
# 2. Create OpenAPI spec (openapi.yaml)
|
||||
# openapi: 3.0.3
|
||||
# info:
|
||||
# title: DanceLessonsCoach API
|
||||
# title: dance-lessons-coach API
|
||||
# version: 1.0.0
|
||||
|
||||
# 3. Generate server types
|
||||
@@ -654,9 +654,9 @@ go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@latest
|
||||
# 2. Create OpenAPI spec (openapi.yaml)
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: DanceLessonsCoach API
|
||||
title: dance-lessons-coach API
|
||||
version: 1.0.0
|
||||
description: API for DanceLessonsCoach service
|
||||
description: API for dance-lessons-coach service
|
||||
servers:
|
||||
- url: http://localhost:8080/api
|
||||
description: Development server
|
||||
|
||||
Reference in New Issue
Block a user