SpringBootRestAPI

RESTAPI模板 - 春季靴子 + MongoDB

降落

使用Spring-boot-Microservices的REST API的现成模板MongoDB作为数据库，与Codecov和Sonarqube集成，可部署到Cloud。该模板可以插入任何应用程序，以轻松地启动任务，而无需从头开始写所有内容。

任务列表进度

• 使用Springboot的REST控制器和型号
• MongoDB配置
• travisci构建
• Sonarqube集成
• Jacoco测试报告
• JWT身份验证
• 80％及以上的代码覆盖范围（使用Codecov或Coveralls）
• 云部署

入门

• 将该项目导入您喜欢的IDE后，并结帐此存储库。

先决条件和安装步骤

• 获取可以连接到的MongoDB的运行实例。有关MongoDB入门的更多信息，请访问其在线教程。

• 首先创建一个测试数据库。我将使用MongoDB Shell中的以下命令或通过MongoDB Compass（例如MongoDB Compass： use rest_tutorial;

• 创建一个样本集，该集合将保存有关不同类型宠物的数据。让我们使用以下命令创建集合： db.createCollection("pets");

• 创建集合后，我们需要添加一些数据！ We can add data to the collection with the below query, you can add any number of data like this : db.pets.insertMany([ { "name" : "Spot", "species" : "dog", "breed" : "pitbull" }, { "name" : "Daisy", "species" : "cat", "breed" : "calico" }, { "name" : "Bella", "species" : "dog", "breed" : "australian shepard" } ]);

• 在Application.properties中添加MongoDB身份验证数据库，用户名和密码。如果您在本地运行时没有身份验证，则还可以从此文件中删除这些属性。

• 在数据库中创建用户角色。用户角色可以是“用户，主持人或管理员”之一

 db.roles.insertMany([
   { name: "ROLE_USER" },
   { name: "ROLE_MODERATOR" },
   { name: "ROLE_ADMIN" },
])

运行测试

服务器启动后，您首先需要注册用户并登录该用户以获取令牌。

用户注册

用户登录

获得令牌后，您需要将其传递给邮递员中后端的每个请求的令牌，请选择“标题”部分，然后输入密钥的Authorization
价值的“承载者”

您可以自由测试您的API。使用Postman进行以下测试：

getAllpets

getPetbyId

createpet

删除

modifypetByid

完成所有测试后，您可以使用端点/api/auth/logout来注销

注销

代码覆盖范围

对于代码覆盖报告集成，我已经展示了使用Codecov和Coveralls的示例，因为两者都非常受欢迎且易于与Travis集成。

• codecov-只需在.travis.yml中添加此行，它将将Jacoco报告发送到Codecov控制台

• 工作岗位 - 需要在build.gradle文件中添加Coveralls插件和Jacoco报告路径。也需要更改.travis..yml而不是Codecov来使用地下

发出请求模板

Are you up for your first Issue Request for this project !!!太棒了，但请首先浏览问题模板。md并使用此模板提交任何问题请求。

拉请求模板

Are you up for your first PR for this project !!!太棒了，但请首先通过拉动请求模板。md并使用此模板提交您的PR。

贡献

请阅读有关我们的行为守则的详细信息以及向我们提交拉的请求的过程，请阅读贡献。

作者

• 古拉夫·鲁西亚（Gourav Rusiya）