美文网首页
Spring Boot 集成Swagger

Spring Boot 集成Swagger

作者: 三只仓鼠 | 来源:发表于2018-01-24 10:24 被阅读0次

    Idea创建项目


    image.png
    image.png
    image.png

    添加yml配置

    spring:
      datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://localhost:3306/test
        username: root
        password: root
      jpa:
        hibernate:
          ddl-auto: update
        show-sql: true
    

    实体类

    package com.miles.demo;
    
    import io.swagger.annotations.ApiKeyAuthDefinition;
    import io.swagger.annotations.ApiModelProperty;
    
    import javax.persistence.Entity;
    import javax.persistence.GeneratedValue;
    import javax.persistence.Id;
    
    @Entity
    public class User {
        public User() {
        }
    
        @Id
        @GeneratedValue
        private Integer id;
    
        @ApiModelProperty("姓名")
        private String name;
    
        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;
        }
    
        @ApiModelProperty("年龄")
        private Integer age;
    }
    
    

    仓储类

    package com.miles.demo;
    
    import org.springframework.data.jpa.repository.JpaRepository;
    
    public interface userRepository extends JpaRepository<User,Integer>{
    }
    

    控制器

    package com.miles.demo;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.jws.soap.SOAPBinding;
    import java.util.List;
    
    
    @Api(tags = "用户管理")
    @RestController
    public class UserController {
    
        @Autowired
        private userRepository userRepository;
    
        @ApiOperation(value = "获取所有用户列表")
        @GetMapping(value = "/users")
        public List<User> userList()
        {
            return userRepository.findAll();
        }
    
        @ApiOperation(value = "创建用户")
        @PostMapping(value = "/users")
        public User addUser(@RequestBody User user)
        {
            return userRepository.save(user);
        }
    }
    
    

    POM依赖

    <?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.miles</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.9.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>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-jpa</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>com.spring4all</groupId>
                <artifactId>spring-boot-starter-swagger</artifactId>
                <version>1.5.1.RELEASE</version>
            </dependency>
        </dependencies>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>
    
    

    安装依赖以后输入以下地址进行访问
    http://127.0.0.1:8081/swagger-ui.html

    image.png
    https://github.com/SpringForAll/spring-boot-starter-swagger 该地址为引用的swagger第三方库
    https://github.com/596442958/Spring-Boot GitHub代码实例

    相关文章

      网友评论

          本文标题:Spring Boot 集成Swagger

          本文链接:https://www.haomeiwen.com/subject/bdiyaxtx.html