swagger配置

1、导入坐标

   <!--配置swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

 

创建配置类:

SwaggerConfig

/**
 * @Description
 * @Author by mocar小师兄
 * @Date 2019/10/23 16:19
 **/
@Configuration  // 声明当前配置类
@EnableSwagger2  //开启swagger2
public class SwaggerConfig {
    @Value("${swagger.basePackage}")
    private String basePackage;//扫描的包
    @Value("${swagger.title}")
    private String title;
    @Value("${swagger.description}")
    private String description;
    @Value("${swagger.version}")
    private String version;


    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .version(version)
                .build();
    }


}

 

application.yml配置

server:
  port: 8085

spring:
  application:
    name: swagger-demo


swagger:
  basePackage: com.itcast.controller
  title: FLOWM RESTful APIs
  description: FLOWM RESTful APIs
  version: v2

 

 

pojo
package com.itcast.pojo;

/**
 * @Description
 * @Author by mocar小师兄
 * @Date 2019/10/23 16:29
 **/
public class User {
    private String username;
    private Integer age;


    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Integer getAge() {
        return age;
    }

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

    @Override
    public String toString() {
        return "User{" +
                "username='" + username + '\'' +
                ", age=" + age +
                '}';
    }
}

 

 

Controller
package com.itcast.controller;

import com.itcast.pojo.User;
import io.swagger.annotations.ApiOperation;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

/**
 * @Description
 * @Author by mocar小师兄
 * @Date 2019/10/23 16:29
 **/

@RestController
@RequestMapping("/user")
public class UserController {

    @ApiOperation(value = "获取一个用户")
    @GetMapping("/findOne")
    public ResponseEntity<User> findOneUser(){
        User user = new User();
        user.setUsername("zhangsan");
        user.setAge(18);
        return ResponseEntity.status(200).body(user);
    }
}

 

 

启动程序:

浏览器输入:

http://localhost:8085/swagger-ui.html

 

 

参考:

 

https://blog.csdn.net/qq_42175986/article/details/80760038

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值