この記事は主に、swaggerUIをspringbootと統合し、mongodbデータベースを最も簡単な方法で操作するデモを構築するためのガイドです。ナンセンスは正しくありません。直接プロセスに進んでください：
1. SpringBootプロジェクトを作成する
2. swaggerのpom依存関係を追加する
インポートするjarパッケージをpomファイルに追加します。
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<!-- 接口API生成html文档 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
3. mongodbデータベースの接続構成アイテムを追加する
構成済みのIP、ポート番号、およびデータベース名を直接application.propertiesファイルに追加し、アカウントのパスワードを追加して、ymlに構成すると、ファイル自体を変更できます
spring.data.mongodb.host=127.0.0.1
spring.data.mongodb.port=27017
spring.data.mongodb.database=Test
4.パッケージ構造を作成する
5.コードを書く
- Swaggerスタートアップクラス：
package com.mongodb.demo.config;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class swaggerConfig {
@Bean
public Docket swaggerSpringMvcPlugin() {
return new Docket(DocumentationType.SWAGGER_2).select().
apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
}
}
@Configurationを使用して、これを春までにロードする必要がある起動クラスとしてマークします。@ EnableSwagger2を使用して、これがswaggerの起動クラスであることを示します
- ユーザーエンティティクラス
package com.mongodb.demo.entity;
/**
* <p>title:com.mongodb.demo.entity</p>
* <p>Company:阿里巴巴</p>
* author:及时雨
* date:2019/9/1
* version 1.0
*/
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;
import org.springframework.data.mongodb.core.mapping.Field;
/**
* 实体层
* @author linhongcun
*
*/
@Document(collection="t_user")
public class User {
@Id // 指定ID
private String id;
@Field("userName") // 指定域名，覆盖默认
private String userName;
@Field("password") // 指定域名，覆盖默认
private String password;
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
@Document（collection =“ t_user”）テーブル名はドキュメントオブジェクト、t_userは挿入する必要があるコレクション（テーブル名と同様）、@ IdはID、作成しない場合は自動的に作成され、@ Fieldはキーと値のペアのキー価値
- 元々レイヤーで記述する必要があったコントローラークラスは、ここでは簡単にするために直接記述しています。
package com.mongodb.demo.controller;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.mongodb.demo.entity.User;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* 控制层
* @author linhongcun
*
*/
@RestController
@RequestMapping("/user")
@EnableSwagger2
public class UserController {
@Autowired
private MongoTemplate mongoTemplate;
/**
* 1、增
* @param user
* @return
*/
@PostMapping("/insert")
@ApiOperation (value = "insert",notes = "插入")
public User insertUser(User user) {
// 可以用 save 替代
mongoTemplate.insert(user);
return user;
}
/**
* 2、查
* @param id
* @return
*/
@GetMapping("/get/{id}")
@ApiOperation (value = "get",notes = "查询")
public User getUserById(@PathVariable String id) {
return mongoTemplate.findById(id, User.class);
}
/**
* 3、删
* @param id
* @return
*/
@DeleteMapping("/delete/{id}")
@ApiOperation (value = "delete",notes = "删除")
public User deleteUserById(@PathVariable String id) {
User user = mongoTemplate.findById(id, User.class);
mongoTemplate.remove(user);
return user;
}
/**
* 4、改
* @param user
* @return
*/
@PutMapping("/update")
@ApiOperation (value = "update",notes = "修改")
public User updateUser(User user) {
// save 可增可改！
mongoTemplate.save(user);
return user;
}
/**
* 5、全
* @return
*/
@GetMapping("/get/all")
@ApiOperation (value = "getAll",notes = "获取所有")
public List<User> getAllUsers() {
return mongoTemplate.findAll(User.class);
}
/**
* 6、查 ++：属性、分页
* @param user
* @param page
* @param size
* @return
*/
@GetMapping("/select/{page}/{size}")
@ApiOperation (value = "select",notes = "分页查询")
public Map<String, Object> selectUserByProperty(User user, @PathVariable int page, @PathVariable int size) {
// 条件
Criteria criteria1 = Criteria.where("userName").is(user.getUserName());
Criteria criteria2 = Criteria.where("password").is(user.getPassword());
Query query = new Query();
if (user.getUserName() != null) {
query.addCriteria(criteria1);
}
if (user.getPassword() != null) {
query.addCriteria(criteria2);
}
// 数量
long total = mongoTemplate.count(query, User.class);
// 分页
query.skip((page - 1) * size).limit(size);
List<User> data = mongoTemplate.find(query, User.class);
Map<String, Object> map = new HashMap<String, Object>();
map.put("data", data);
map.put("total", total);
return map;
}
}
コードを記述したら、MongodbApplicationスタートアップクラスを直接開始し、テスト用のswagger URLを開きます（http：// localhost：8080 / swagger-ui.html＃/）：
データを挿入：
データベースを表示：
ここで、簡単なデモできました。
