SEKOIA-IO/documentation

# SEKOIA.IO 文档 该文档服务向公众公开了用户文档和开发者文档。内容由 Sekoia.io 团队管理，但也邀请社区参与改进。 ## 为文档做贡献 您可以点击屏幕右上角的 **Fork** 按钮，在您的 GitHub 账户中创建此仓库的副本。此副本称为 *fork*。在您的 fork 中进行所需的任何更改，当您准备好将这些更改提交给我们时，请前往您的 fork 并创建一个新的 pull request 来通知我们。 一旦您的 pull request 创建完成，Sekoia.io 的审阅者将负责提供清晰、可操作的反馈。 ## 本地测试 ### 后端 该项目由 `uv` 管理，在本地测试文档之前应先安装它。请参阅 [“Installing uv”](https://docs.astral.sh/uv/getting-started/installation/) 文档以安装此工具。 该服务依赖于由 [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) 辅助的 [MkDocs](https://www.mkdocs.org/) Python 框架。要在您计算机的 `8000` 端口上提供文档服务，您应该创建一个 Python 虚拟环境，安装 `pyproject.toml` 中详述的少量依赖项，并触发 MkDocs 服务器的执行： ``` $ uv run mkdocs serve --strict ``` ### 前端 前端位于 `./lib/openapi-viewer`。您需要安装 node 和 yarn。 要在本地提供文档服务，您需要先加载上面的后端服务。 安装 yarn ``` $ npm install yarn -g ``` 启动前端 ``` $ yarn install $ yarn start ``` 访问 http://127.0.0.1:8080/developer/api/ ## 指南 * 您可以使用绝对链接和图片，例如 `[caption](/folder/page.md#anchor)` 或 ``，它们将被解释为相对于 `docs/` 文件夹。因此，示例链接将指向仓库中必须存在的 `docs/folder/page.md`。`mkdocs serve --strict` 将帮助您捕获任何断开的链接 * 当您想指向开发者文档时，请使用完整的 URL，例如 `[delete_playbook_endpoint](https://docs.sekoia.io/xdr/develop/rest_api/playbooks/#tag/Playbooks/operation/delete_playbook_resource)`，因为 API 文档是通过 ReDoc 从 app.sekoia.io 平台 API 获取的 OpenAPI 规范在客户端渲染的 * 在链接到仓库中的 markdown 文件时，请始终包含 `.md` 扩展名：`[link](/integration/example/index.md)` 是可以的，而 `[link](/integration/example/)` 或 `[link](/integration/example/index)` 将无法工作。 * CI（通过 `mkdocs build --strict`）会严格验证所有指向内部页面和锚点的链接，以发现任何断开的链接。因此，请尽可能避免使用完整的 URL 指向内部页面，因为它们不会被自动断链验证覆盖。

标签：API文档, DNS解析, EDR, GNU通用公共许可证, MITM代理, MkDocs, Node.js, OpenAPI, Python, SaaS, Yarn, 协作, 威胁情报, 安全信息与事件管理, 安全运营, 开发者工具, 开源项目, 扫描框架, 技术文档, 搜索引擎爬取, 文档, 无后门, 社区贡献, 网络安全, 脆弱性评估, 自定义脚本, 自定义脚本, 逆向工具, 隐私保护