swagger-api实现简单的数据增删改查

(1)、首先创建springBoot工程

pom.xml代码:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>

   <groupId>com.example</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>

   <name>demo</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.10.RELEASE</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>

   <dependencies>
      <dependency>
         <groupId>junit</groupId>
         <artifactId>junit</artifactId>
         <version>4.12</version>
         <scope>test</scope>
      </dependency>

      <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
         <version>1.7.5</version>
      </dependency>

      <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-log4j12</artifactId>
         <version>1.7.12</version>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter</artifactId>
         <exclusions>
            <exclusion>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
         </exclusions>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-log4j</artifactId>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-jpa</artifactId>
      </dependency>

      <dependency>
         <groupId>mysql</groupId>
         <artifactId>mysql-connector-java</artifactId>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>

      <dependency>
         <groupId>org.apache.tomcat.embed</groupId>
         <artifactId>tomcat-embed-jasper</artifactId>
         <scope>provided</scope>
      </dependency>

      <dependency>
         <groupId>javax.servlet</groupId>
         <artifactId>jstl</artifactId>
         <version>1.2</version>
      </dependency>

      <dependency>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-war-plugin</artifactId>
         <version>3.2.0</version>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-thymeleaf</artifactId>
      </dependency>

      <dependency>
         <groupId>org.mybatis.spring.boot</groupId>
         <artifactId>mybatis-spring-boot-starter</artifactId>
         <version>1.3.1</version>
      </dependency>

      <dependency>
         <groupId>com.alibaba</groupId>
         <artifactId>druid</artifactId>
         <version>1.0.26</version>
      </dependency>

      <!--输出APi-->
      <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger2</artifactId>
         <version>2.5.0</version>
      </dependency>
      <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger-ui</artifactId>
         <version>2.5.0</version>
      </dependency>

   </dependencies>

   <build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>
</project>

(2)、再创建实体类

package com.example.demo.entity;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;

@Component
@Entity
@Table(name="person")
public class Person {
    @Id
    @GeneratedValue
    private Integer id;
    private String name;
    private Integer age;

    //必须要有构造函数
    public Person() {
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Person [id=" + id + ", name=" + name + ", age=" + age +"]" ;
    }
}

(3)、整合springBoot和mybatis

package com.example.demo.mapper;

import com.example.demo.entity.Person;
import org.apache.ibatis.annotations.*;

import java.util.List;

@Mapper
public interface PersonMapper {
   //查询所有信息
    @Select("select * from person")
    public List<Person> getList();

    //添加一条记录
    @Insert("insert into person(id,name,age) values (#{id},#{name},#{age})")
    public void addPerson(Person person);

    //查询单条记录
    @Select("select * from person where id=#{id}")
    public Person getPersonOne(Integer id);

    //修改一条记录
    @Update("update person set name=#{name},age=#{age} where id=#{id}")
    public void updatePerson(Person person);
    //删除一条记录
    @Delete("delete from person where id=#{id}")
    public void deletePersonById(Integer id);
}

(4)、controller类:

package com.example.demo.controller;

import com.example.demo.entity.Person;
import com.example.demo.service.PersonService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import java.util.List;
@Api(value = "简单test",description = "简单的测试API")
@RestController
public class PersonController {

    @Autowired
    private PersonService personService;

    //personList
    @ApiOperation("查询全部记录")
    @RequestMapping(value = "/personList",method = RequestMethod.GET)
    public List<Person> getList(){
        List<Person> list = this.personService.getList();
        return list;
    }
    //添加一条数据
    @ApiOperation("添加一条记录")
    @RequestMapping(value = "/addPerson",method = RequestMethod.POST)
    public String addPerson(@ModelAttribute Person person){
        Person p = new Person();
        p.setId(person.getId());
        p.setName(person.getName());
        p.setAge(person.getAge());
        this.personService.addPerson(p);
        return "success";
    }
    //查询单个记录
    @ApiOperation("根据ID查询")
    @RequestMapping(value = "/getPersonOne/{id}",method = RequestMethod.GET)
    public Person getPersonOne(@ApiParam("ID")@PathVariable Integer id){
        Person person = this.personService.getPersonOne(id);
        return person;
    }
    //修改单条记录
    @ApiOperation("根据ID修改记录")
    @RequestMapping(value = "/updatePerson/{id}",method = RequestMethod.PUT)
    public String updatePerson(@ApiParam("被修改的ID")@PathVariable Integer id,@RequestBody Person person){
        Person p = new Person();
        p.setId(id);
        p.setName(person.getName());
        p.setAge(person.getAge());
        this.personService.updatePerson(p);
        return "success";
    }

    //删除一条数据
    @ApiOperation("根据ID删除记录")
    @RequestMapping(value = "/deletePerson/{id}",method = RequestMethod.DELETE)
    public String deletePersonById(@ApiParam("被删除的ID")@PathVariable Integer id){
        this.personService.deletePersonById(id);
        return "success";
    }

}

(5)、swagger类:

package com.example.demo.utils;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerApi {

    @Bean
    public Docket buildDocket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApi())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo buildApi(){
        return new ApiInfoBuilder()
                .title("springBoot test Swagger build document API")
                .contact("sanpiao")
                .version("1.0").build();
    }

}

(6)、运行http://localhost:8080/swagger-ui.html

结果:



                
  • 1
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: .NET Core WebAPI 增删改查是指使用.NET Core框架开发WebAPI应用程序,实现数据的增加、删除、修和查询操作。这些操作通常是通过HTTP请求来完成的,例如使用POST请求来添加数据,使用DELETE请求来删除数据,使用PUT请求来更新数据,使用GET请求来查询数据。在.NET Core WebAPI应用程序中,可以使用各种技术和工具来实现这些操作,例如Entity Framework Core、Dapper、Swagger等。 ### 回答2: .NET Core WebAPI是一个轻量级、高性能、跨平台的框架,它能够快速开发现代化的Web应用程序。WebAPI结合.NET Core框架和ASP.NET Core,具有良好的可扩展性、安全性和性能,是开发企业级Web服务的理想选择。 在使用.NET Core WebAPI进行增删改查操作时,需要通过HTTP请求方法来进行不同的操作。通常,我们使用以下几种请求方法进行数据操作: - GET:获取数据 - POST:新建数据 - PUT:修数据 - DELETE:删除数据 接下来,让我们详细介绍.NET Core WebAPI如何进行增删改查操作。 ### 增加数据 使用POST请求方法向WebAPI发送数据,可以实现数据库中创建新数据。以下是一个示例: ```csharp [HttpPost] public IActionResult Post([FromBody] Product product) { if (product == null) { return BadRequest(); } _context.Products.Add(product); _context.SaveChanges(); return CreatedAtRoute("GetProduct", new { id = product.Id }, product); } ``` 这个方法通过FromBody属性获取一个Product对象并将其添加到数据库中。如果Product对象为空,则返回一个BadRequest响应。如果添加成功,则返回一个CreatedAtRoute响应,该响应包含新创建的产品的ID。 ### 更新数据 使用PUT请求方法向WebAPI发送数据,可以实现更新数据库中的现有数据。以下是一个示例: ```csharp [HttpPut("{id}")] public IActionResult Put(int id, [FromBody] Product product) { if (product == null || product.Id != id) { return BadRequest(); } var existingProduct = _context.Products.FirstOrDefault(p => p.Id == id); if (existingProduct == null) { return NotFound(); } existingProduct.Name = product.Name; existingProduct.Price = product.Price; _context.Products.Update(existingProduct); _context.SaveChanges(); return new NoContentResult(); } ``` 这个方法根据传递的ID和FromBody属性中的Product对象来更新数据库中的现有产品。如果Product对象为空或ID不匹配,则返回BadRequest响应。如果要更新的产品不存在,则返回NotFound响应。如果更新成功,则返回一个NoContent响应。 ### 删除数据 使用DELETE请求方法向WebAPI发送数据,可以实现删除数据库中的现有数据。以下是一个示例: ```csharp [HttpDelete("{id}")] public IActionResult Delete(int id) { var product = _context.Products.FirstOrDefault(p => p.Id == id); if (product == null) { return NotFound(); } _context.Products.Remove(product); _context.SaveChanges(); return new NoContentResult(); } ``` 这个方法根据传递的ID来删除数据库中存在的产品。如果指定ID的产品不存在,则返回NotFound响应。如果删除成功,则返回一个NoContent响应。 ### 查询数据 使用GET请求方法向WebAPI发送数据,可以实现检索数据库中的现有数据。以下是一个示例: ```csharp [HttpGet("{id}", Name = "GetProduct")] public IActionResult GetById(int id) { var product = _context.Products.FirstOrDefault(p => p.Id == id); if (product == null) { return NotFound(); } return new ObjectResult(product); } [HttpGet] public IEnumerable<Product> GetAll() { return _context.Products.ToList(); } ``` 这个方法根据传递的ID来检索数据库中的产品。如果指定ID的产品不存在,则返回NotFound响应。如果存在,则返回一个ObjectResult响应,该响应包含指定产品的详细信息。此外,还可以使用一个不带参数的GET请求方法来检索所有产品。这个方法直接返回一个包含所有产品的IEnumerable<Product>列表。 ### 回答3: 随着.NET Core技术的不断发展,越来越多的开发人员使用.NET Core来构建Web应用程序。对于Web应用程序而言,涉及最频繁的就是增删改查功能,下面我将就.NET Core Web API中的这四种功能进行详细的讲解。 一、增加数据 在.NET Core Web API中,添加数据有多种方式,最常用的方式是使用Http请求中的POST方法。当你的应用程序收到POST请求时,你需要从请求体中获取数据,并将数据转换为所需的格式。笔者常用 Newtonsoft.Json 库来将json数据转换为对象,然后将对象作为参数传递到API中,然后通过Entity Framework或Dapper对数据库进行操作,如下所示: [HttpPost] public async Task<ActionResult> AddUser(User user) { try { await _userService.AddUser(user); return Ok(); } catch (Exception ex) { return StatusCode(StatusCodes.Status500InternalServerError, ex.Message); } } 在代码片段中,我们可以看到,当我们调用API中的AddUser方法时,我们首先将请求体中的json数据转换为用户对象(User类),然后我们使用_UserRepository.Add()来将用户保存到数据库中。 二、删除数据 在.NET Core Web API中,删除数据同样可以使用Http请求中的DELETE方法。当您的应用程序接收到DELETE请求时,您需要从URL中提取标识符或参数以确定要删除的对象。然后,就可以调用数据访问层以从数据库中删除所需的对象。下面是一个简单的删除示例: [HttpDelete("{id}")] public async Task<ActionResult> RemoveUser(int id) { try { var user = await _userService.GetUserById(id); if (user == null) return NotFound(); await _userService.RemoveUser(user); return NoContent(); } catch (Exception ex) { return StatusCode(StatusCodes.Status500InternalServerError, ex.Message); } } 在以上代码中,我们使用.UserService.GetUserById方法来获取用户对象,并确保用户存在。然后,我们使用_UserRepository.Remove()将用户从数据库中删除。 三、修数据 在.NET Core Web API中,更新数据也可以使用Http请求中的PUT方法。当你的应用程序收到PUT请求时,你需要从请求体中获取数据,并将数据转换为所需的格式。然后,你可以调用取消访问层以从数据库中更新所需的对象。示例代码如下: [HttpPut("{id}")] public async Task<ActionResult> UpdateUser(int id, User user) { try { if (id != user.Id) return BadRequest("Invalid User ID"); var existingUser = await _userService.GetUserById(id); if (existingUser == null) return NotFound(); await _userService.UpdateUser(user); return NoContent(); } catch (Exception ex) { return StatusCode(StatusCodes.Status500InternalServerError, ex.Message); } } 在以上代码中,我们首先检查请求体中传递的用户ID是否与请求的ID匹配。然后,我们从数据库中获取现有的用户,并更新用户数据。最后,我们使用_UserRepository.SaveChanges()将新的用户数据保存到数据库中。 四、查询数据 在.NET Core Web API中,查询数据最常用的方法就是使用Http请求中的GET方法。当您的应用程序接收到GET请求时,您需要从URL中提取标识符或参数以确定要检索的对象。然后,你可以调用数据访问层以检索所需的数据。下面是一个简单的查询示例: [HttpGet("{id}")] public async Task<ActionResult> GetUserById(int id) { try { var user = await _userService.GetUserById(id); if (user == null) return NotFound(); return Ok(user); } catch (Exception ex) { return StatusCode(StatusCodes.Status500InternalServerError, ex.Message); } } 在以上代码中,我们从数据库中获取用户,并确保用户存在。然后,我们将用户数据返回给客户端。在以上四种功能中,我们通过使用.NET Core Web API实现增删改查的操作,极大的提高了数据处理效率。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值