/swaggo-sync

add swag_dto in main.go folder, use models under swag_dto for swag api comment only. this util provides a syncer to copy origin dtos

Primary LanguageGo

一、说明

此目录仅供swago命令使用，因为其解析其他的pkg文件会报错。

  • swag init --parseDependency会连带项目使用到的第三方库一起解析，造成莫名其妙的parse comment error
  • 降级到1.6.7版本，会导致生成的swagger文档，字段没有注释
  • 所以折中采用这个方案

二、使用

1、代码使用

  • 方法上添加的swag的注释里面，dto写成swag_dto.下面的
// @Param UserLogInReq body swag_dto.UserLogInReq true "参数"
// @Success 200  {object} swag_dto.UserLogInResp
  • go不需要引用swag_dto这个包

2、makefile新增

swag:
	cd cmd/server/interface/rest/swag_dto/swagsync && ./swagsync
	cd cmd/server && swag init
  • 自动根据配置复制代码实际使用的文件到swag_dto下