README

PHP库，提供创建API的基本功能。需要其他库...

入门指南

为了帮助您轻松开始使用GitLab，这里有一份推荐的下一步操作列表。

已经是专家？只需编辑此README.md并使其成为您自己的。想让它变得简单？ 使用底部的模板！

添加您的文件

• [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
• [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) 或使用以下命令推送现有的Git仓库

cd existing_repo
git remote add origin https://gitlab.com/infosophy/api.git
git branch -M main
git push -uf origin main

集成您的工具

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://gitlab.com/infosophy/api/-/settings/integrations)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动关闭来自合并请求的问题](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [启用合并请求审批](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
• [ ] [当管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用GitLab内置的持续集成。

• [ ] [开始使用GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用安全测试(SAST)分析您的代码以查找已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• [ ] [使用基于拉取的部署以改进Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/user/clusters/agent/)
• [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:0c8904d64b6db8ae841e4644c874f723?https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

编辑此README

当您准备好使此README成为您自己的时，只需编辑此文件并使用下面的方便模板（或者您也可以随意组织结构 - 这只是一个起点！）感谢 makeareadme.com 提供此模板。

好的README建议

每个项目都是不同的，所以请考虑哪些部分适用于您。模板中使用的部分是大多数开源项目的建议。此外，请注意，虽然README可能太长太详细，但比太短好。如果您认为您的README太长，可以考虑使用其他形式的文档，而不是删除信息。

名称

为您的项目选择一个易于理解的名称。

描述

让人们知道您的项目可以具体做什么。提供上下文，并添加任何可能不熟悉的参考链接。也可以在此处添加功能列表或背景子部分。如果有与您的项目不同的替代方案，这是一个列出不同因素的好地方。

徽章

在某些README中，您可能会看到一些小图像，传达元数据，例如项目是否所有测试都通过。您可以在README中添加一些徽章。许多服务也提供了添加徽章的说明。

视觉

根据您所制作的内容，包括截图甚至视频（您通常会看到GIF而不是实际视频）可能是个好主意。工具如ttygif可以帮助，但请查看Asciinema以获取更复杂的方法。

安装

在特定生态系统内，可能有安装事物的通用方式，例如使用Yarn、NuGet或Homebrew。然而，考虑到阅读您的README的人可能是个新手，需要更多的指导。列出具体的步骤有助于消除歧义，并尽快让人们开始使用您的项目。如果它只在特定的环境中运行，如特定的编程语言版本或操作系统，或者有需要手动安装的依赖项，也请添加一个“要求”子部分。

使用

广泛使用示例，并在可能的情况下展示预期的输出。最好在行内提供可以演示的最小使用示例，同时提供链接到更复杂的示例（如果它们太长，不适合合理地包含在README中）。

支持

告诉人们他们可以到哪里寻求帮助。可以是问题跟踪器、聊天室、电子邮件地址等的任何组合。

路线图

如果您对未来发布有想法，将其列在README中是个好主意。

贡献

说明您是否接受贡献以及接受贡献的要求。

对于想要对您的项目进行修改的人来说，拥有一些关于如何开始的文档会很有帮助。也许有一个他们应该运行的脚本，或者一些他们需要设置的环境变量。将这些步骤明确化。这些说明对您未来的自己也可能有用。

您还可以记录一些代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并降低更改无意中破坏东西的可能性。如果需要进行外部设置，例如在浏览器中测试时启动 Selenium 服务器，那么运行测试的说明特别有帮助。

作者和致谢

感谢那些为项目做出贡献的人。

许可证

对于开源项目，说明其许可证。

项目状态

如果您已经耗尽了为项目投入的精力或时间，请在 README 的顶部注明开发已放缓或完全停止。有人可能会选择分支您的项目，或者自愿成为维护者或所有者，使项目继续进行。您还可以明确请求维护者。