joylink
/
rts-sim-testing-service
6
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

【swagger 注释修改】

This commit is contained in:
weizhihong 2023-08-28 15:24:17 +08:00
parent 88ee3e38db
commit 16ea58f029
9 changed files with 1459 additions and 1503 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api/category.go
View File

@ -131,7 +131,7 @@ func createCategory(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/category/:id [get]
// @Router /api/v1/category/{id} [get]
func queryCategoryInfo(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -159,7 +159,7 @@ func queryCategoryInfo(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/category/:id [put]
// @Router /api/v1/category/{id} [put]
func updateCategoryInfo(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -196,7 +196,7 @@ func updateCategoryInfo(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/category/:id [delete]
// @Router /api/v1/category/{id} [delete]
func deleteCategory(c *gin.Context) {
user, _ := c.Get(middleware.IdentityKey)
zap.S().Debug("id删除草稿的图形数据", user)

8
api/drafting.go
View File

@ -105,7 +105,7 @@ func createDrafting(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/drafting/:id/saveAs [post]
// @Router /api/v1/drafting/{id}/saveAs [post]
func saveAsDrafting(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -144,7 +144,7 @@ func saveAsDrafting(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/drafting/:id [get]
// @Router /api/v1/drafting/{id} [get]
func queryDraftingInfo(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -172,7 +172,7 @@ func queryDraftingInfo(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/drafting/:id [put]
// @Router /api/v1/drafting/{id} [put]
func updateDraftingInfo(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -209,7 +209,7 @@ func updateDraftingInfo(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/drafting/:id [delete]
// @Router /api/v1/drafting/{id} [delete]
func deleteDrafting(c *gin.Context) {
user, _ := c.Get(middleware.IdentityKey)
zap.S().Debug("id删除草稿的图形数据", user)

6
api/project.go
View File

@ -129,7 +129,7 @@ func createProject(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/Project/:id [get]
// @Router /api/v1/Project/{id} [get]
func queryProjectInfo(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -157,7 +157,7 @@ func queryProjectInfo(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/Project/:id [put]
// @Router /api/v1/Project/{id} [put]
func updateProjectInfo(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -194,7 +194,7 @@ func updateProjectInfo(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/Project/:id [delete]
// @Router /api/v1/Project/{id} [delete]
func deleteProject(c *gin.Context) {
user, _ := c.Get(middleware.IdentityKey)
zap.S().Debug("id删除草稿的图形数据", user)

4
api/projectLink.go
View File

@ -33,7 +33,7 @@ func InitProjectLinkRouter(api *gin.RouterGroup, authMiddleware *jwt.GinJWTMiddl
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/projectLink/info/:id [get]
// @Router /api/v1/projectLink/info/{id} [get]
func queryProjectLinkInfo(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -60,7 +60,7 @@ func queryProjectLinkInfo(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/projectLink/mapInfo/trainSize/:id [get]
// @Router /api/v1/projectLink/mapInfo/trainSize/{id} [get]
func queryTrainSizeByMapId(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {

2
api/publishedGi.go
View File

@ -61,7 +61,7 @@ func pageQueryPublishedGi(c *gin.Context) {
// @Tags 发布的图形数据Api
// @Accept json
// @Produce json
// @Param pagePublishedGiReqDto query publishedGi.PublishedGiReqDto true "查询参数"
// @Param publishedGiListReqDto query publishedGi.PublishedGiListReqDto true "查询参数"
// @Success 200 {object} []model.PublishedGi
// @Failure 401 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto

18
api/trainManage.go
View File

@ -111,7 +111,7 @@ func createTrainModel(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/model/:id [get]
// @Router /api/v1/trainManage/model/{id} [get]
func queryTrainModel(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -139,7 +139,7 @@ func queryTrainModel(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/model/:id [put]
// @Router /api/v1/trainManage/model/{id} [put]
func updateTrainModel(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -176,7 +176,7 @@ func updateTrainModel(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/model/:id [delete]
// @Router /api/v1/trainManage/model/{id} [delete]
func deleteTrainModel(c *gin.Context) {
idStr := c.Param("id")
id, err := strconv.Atoi(idStr)
@ -326,7 +326,7 @@ func createTrainSize(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/size/:id [get]
// @Router /api/v1/trainManage/size/{id} [get]
func queryTrainSize(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -354,7 +354,7 @@ func queryTrainSize(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/size/:id [put]
// @Router /api/v1/trainManage/size/{id} [put]
func updateTrainSize(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -391,7 +391,7 @@ func updateTrainSize(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/size/:id [delete]
// @Router /api/v1/trainManage/size/{id} [delete]
func deleteTrainSize(c *gin.Context) {
idStr := c.Param("id")
id, err := strconv.Atoi(idStr)
@ -511,7 +511,7 @@ func createTrainWheelDiameter(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/wheelDiameter/:id [get]
// @Router /api/v1/trainManage/wheelDiameter/{id} [get]
func queryTrainWheelDiameter(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -539,7 +539,7 @@ func queryTrainWheelDiameter(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/wheelDiameter/:id [put]
// @Router /api/v1/trainManage/wheelDiameter/{id} [put]
func updateTrainWheelDiameter(c *gin.Context) {
id, exist := c.Params.Get("id")
if !exist {
@ -576,7 +576,7 @@ func updateTrainWheelDiameter(c *gin.Context) {
// @Failure 401 {object} dto.ErrorDto
// @Failure 404 {object} dto.ErrorDto
// @Failure 500 {object} dto.ErrorDto
// @Router /api/v1/trainManage/wheelDiameter/:id [delete]
// @Router /api/v1/trainManage/wheelDiameter/{id} [delete]
func deleteTrainWheelDiameter(c *gin.Context) {
idStr := c.Param("id")
id, err := strconv.Atoi(idStr)

1444
docs/docs.go
View File

File diff suppressed because it is too large Load Diff

1444
docs/swagger.json
View File

File diff suppressed because it is too large Load Diff

30
docs/swagger.yaml
View File

@ -418,7 +418,7 @@ paths:
summary: 创建项目信息
tags:
- 项目信息Api
/api/v1/Project/:id:
/api/v1/Project/{id}:
delete:
consumes:
- application/json
@ -650,7 +650,7 @@ paths:
summary: 创建厂家信息
tags:
- 厂家信息Api
/api/v1/category/:id:
/api/v1/category/{id}:
delete:
consumes:
- application/json
@ -891,7 +891,7 @@ paths:
summary: 创建草稿
tags:
- 草稿Api
/api/v1/drafting/:id:
/api/v1/drafting/{id}:
delete:
consumes:
- application/json
@ -1014,7 +1014,7 @@ paths:
summary: 修改草稿信息
tags:
- 草稿Api
/api/v1/drafting/:id/saveAs:
/api/v1/drafting/{id}/saveAs:
post:
consumes:
- application/json
@ -1195,7 +1195,7 @@ paths:
summary: 保存项目的所有关联信息
tags:
- 项目关联信息Api
/api/v1/projectLink/info/:id:
/api/v1/projectLink/info/{id}:
get:
consumes:
- application/json
@ -1230,7 +1230,7 @@ paths:
summary: 查询项目的所有关联信息
tags:
- 项目关联信息Api
/api/v1/projectLink/mapInfo/trainSize/:id:
/api/v1/projectLink/mapInfo/trainSize/{id}:
get:
consumes:
- application/json
@ -1333,18 +1333,6 @@ paths:
- in: query
name: name
type: string
- description: 页码
example: 1
in: query
name: current
required: true
type: integer
- description: 页面行数
example: 10
in: query
name: size
required: true
type: integer
- in: query
name: time
type: string
@ -1748,7 +1736,7 @@ paths:
summary: 创建列车型号
tags:
- 列车管理Api
/api/v1/trainManage/model/:id:
/api/v1/trainManage/model/{id}:
delete:
consumes:
- application/json
@ -1974,7 +1962,7 @@ paths:
summary: 创建列车尺寸
tags:
- 列车管理Api
/api/v1/trainManage/size/:id:
/api/v1/trainManage/size/{id}:
delete:
consumes:
- application/json
@ -2215,7 +2203,7 @@ paths:
summary: 创建列车轮径
tags:
- 列车管理Api
/api/v1/trainManage/wheelDiameter/:id:
/api/v1/trainManage/wheelDiameter/{id}:
delete:
consumes:
- application/json