siwecos/siwecos-core-api

SIWECOS-Core-API

![Build Status]([] ![Maintainability]([] ![StyleCI]([] ![Scrutinizer Code Quality]([]

镜像概述

SIWECOS Core API是SIWECOS项目的核心接口服务，基于Laravel框架构建，主要用于提供网站安全相关的功能支持，包括域名验证、API接口调用及令牌管理等。该镜像支持本地Valet部署和Docker环境下的Laradock部署，便于开发者进行集成与测试。

核心功能

1. 域名验证：支持元标签验证和文件验证两种方式，确保网站所有权归属。
2. API服务：提供标准化的API接口，可通过Swagger进行接口测试与文档查看。
3. 令牌管理：生成mastertoken用于令牌的创建、撤销及信用管理等操作。

使用场景

• 网站安全检测服务的开发与集成。
• 需要接入SIWECOS安全功能的应用系统。
• 本地或Docker环境下的API开发与测试。

配置说明

1. Valet部署（Mac环境推荐）

安装Valet

1. 安装或更新Homebrew：

bash
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew update

2. 安装PHP 7.1和MySQL：

bash
brew install homebrew/php/php71
brew install mysql

3. 安装Composer并全局安装Valet：

bash
composer global require laravel/valet
valet start

部署Core API

1. 克隆仓库并安装依赖：

bash
git checkout https://github.com/SIWECOS/siwecos-core-api.git
cd siwecos-core-api/CoreApi
composer install

2. 创建环境文件并生成应用密钥：

bash
cp .env.example .env
php artisan key:generate

3. 修改.env文件配置（如数据库信息），生成mastertoken：

bash
php artisan create:mastertoken

4. 链接Valet并访问：

bash
valet link
# 在浏览器中访问coreapi.dev

2. Docker环境部署（Laradock）

切换到laradock目录并启动服务：

bash
docker-compose up -d caddy mariadb

使用workspace容器执行artisan或composer命令：

bash
docker-compose exec --user laradock workspace bash

3. Swagger使用

通过Swagger测试API接口：

1. 进入Documentation目录启动Swagger：

bash
swagger project edit

2. 在Swagger中设置host: localhost和basePath: /api/v1即可测试接口。

4. 域名验证

• 元标签验证：在网站头部添加元标签<meta name="siwecostoken" content="你的密钥">。
• 文件验证：在网站根目录创建密钥.html文件，内容为密钥字符串。