ytshih/inp2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Draft: big refactor

Browse Source
This commit is contained in:
Yi-Ting Shih
2025-09-16 16:03:27 +08:00
parent f527230f1e
commit 7ee2163a95
33 changed files with 338 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
server/docs/docs.go Normal file
View File

@@ -0,0 +1,122 @@
// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"license": {
"name": "0BSD"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/api/lobby/users": {
"get": {
"responses": {}
}
},
"/api/user": {
"get": {
"consumes": [
"application/json"
],
"parameters": [
{
"type": "string",
"description": "Username to be queried",
"name": "username",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
}
}
}
},
"/auth/logout": {
"post": {
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/auth/register": {
"post": {
"consumes": [
"application/json"
],
"parameters": [
{
"description": "query params",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.User"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
}
}
}
}
},
"definitions": {
"models.User": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"BasicAuth": {
"type": "basic"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "0.0.1-alpha",
Host: "",
BasePath: "/",
Schemes: []string{},
Title: "Intro. to Network Programming Game",
Description: "",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}

96
server/docs/swagger.json Normal file
View File

@@ -0,0 +1,96 @@
{
"swagger": "2.0",
"info": {
"title": "Intro. to Network Programming Game",
"contact": {},
"license": {
"name": "0BSD"
},
"version": "0.0.1-alpha"
},
"basePath": "/",
"paths": {
"/api/lobby/users": {
"get": {
"responses": {}
}
},
"/api/user": {
"get": {
"consumes": [
"application/json"
],
"parameters": [
{
"type": "string",
"description": "Username to be queried",
"name": "username",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
}
}
}
},
"/auth/logout": {
"post": {
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/auth/register": {
"post": {
"consumes": [
"application/json"
],
"parameters": [
{
"description": "query params",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.User"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
}
}
}
}
},
"definitions": {
"models.User": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"BasicAuth": {
"type": "basic"
}
}
}

59
server/docs/swagger.yaml Normal file
View File

@@ -0,0 +1,59 @@
basePath: /
definitions:
models.User:
properties:
password:
type: string
username:
type: string
type: object
info:
contact: {}
license:
name: 0BSD
title: Intro. to Network Programming Game
version: 0.0.1-alpha
paths:
/api/lobby/users:
get:
responses: {}
/api/user:
get:
consumes:
- application/json
parameters:
- description: Username to be queried
in: query
name: username
required: true
type: string
responses:
"200":
description: OK
"400":
description: Bad Request
/auth/logout:
post:
responses:
"200":
description: OK
/auth/register:
post:
consumes:
- application/json
parameters:
- description: query params
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.User'
responses:
"200":
description: OK
"400":
description: Bad Request
securityDefinitions:
BasicAuth:
type: basic
swagger: "2.0"