ario_server/readme.md
2025-10-10 07:13:36 -07:00

1.6 KiB
Raw Blame History

Directory Structure

.
├── etc
├── cmd
├── queue
├── generate
├── initialize
├── go.mod
├── internal
│   ├── config
│   ├── handler
│   ├── middleware
│   ├── logic
│   ├── svc
│   ├── types 
│   └── model
├── scheduler
├── pkg
└── script
  • apis: API definition files
  • etc: Directory for static configuration files
  • cmdApplication entry point
  • queueQueue consumption service
  • generateCode generation tools
  • initialize: Initialization system configuration
  • internalInternal modules
    • configConfiguration file parsing
    • handlerHTTP interface handling, with handler as the fixed suffix
    • middlewareHTTP middleware
    • logicBusiness logic handling, with logic as the fixed suffix
    • svcService layer encapsulation
    • typesType definitions
    • modelData models
  • schedulerScheduled tasks
  • pkg Common utility code
  • scriptBuild scripts
Generate Code
$ chmod +x script/generate.sh
$ ./script/generate.sh
Generate Swagger
$ goctl api plugin -plugin goctl-swagger='swagger -filename ppanel.json -pack Response -response "[{\"name\":\"code\",\"type\":\"integer\",\"description\":\"状态码\"},{\"name\":\"msg\",\"type\":\"string\",\"description\":\"消息\"},{\"name\":\"data\",\"type\":\"object\",\"description\":\"数据\",\"is_data\":true}]";' -api ppanel.api -dir .
Format API File
$ goctl api format --dir api/user.api
Build
$ go build -o ppanel ppanel.go
Run
$ ./ppanel run --config etc/ppanel.yaml