websiteTeam/website
1
0
Fork 0
mirror of https://github.com/ZSCNetSupportDept/website.git synced 2025-10-29 17:34:15 +08:00
Code Activity

后端API文档（内测）

Browse Source
This commit is contained in:
govolokatliai
2024-09-23 01:25:50 +08:00
parent c1f35228c4
commit 48c28f77ba
5 changed files with 660 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/devdocs/_后端API服务_/01-概览.md Normal file
View File

@@ -0,0 +1,21 @@
# 后端API服务
## 介绍
该项目作为网维的统一后端API接口而设计，连接网维的数据库，并提供一系列接口给前端以支持网维日常的业务逻辑，其他开发人员可以直接调用这些接口，从而专注与前端，以便于降低整个系统设计的复杂度
该项目采用Go语言编写，Web框架采用echo,ORM框架为gorm,
## 项目地址
https://github.com/ZSCNetSupportDept/zscnetworksupport-api
## 构建
要想构建该项目，你需要安装`Go`和`make`,在一台linux机器上构建
输入`make install`即可安装本项目的依赖，而不构建
输入`make build`即可构建该项目，项目放在`make`文件夹下
## 部署
只需要把可执行文件放在生产环境下运行即可，本项目可能会提供一些静态文件访问，需要将`static`放在与可执行文件相同的目录下
## 配置
程序接受，且只接受一个参数，为配置文件的路径，关于配置文件的格式，请参照“配置”一章
## 运行
运行后，程序会将日志和错误文件输出到stdout中，你可以配置系统服务来使程序开机自启动，将输出定向到日志或者stderr里
在运行程序之后，你还要配置一些反向代理的软件，来将流量导向程序所监听的端口，你还要定期续期https证书，以保证https访问