spring Boot集成swagger

最新推荐文章于 2024-08-17 12:33:42 发布

原创最新推荐文章于 2024-08-17 12:33:42 发布 · 206 阅读

0 ·

CC 4.0 BY-SA版权

springboot 专栏收录该内容

3 篇文章

订阅专栏

spring Boot集成swagger

Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。下面介绍使用spring Boot集成swagger。

1、引入依赖

  <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>

2、开启注解

@EnableEurekaClient
@SpringBootApplication
@EnableSwagger2   //开启注解  (/swagger-ui.html )
public class SpringcloudLoginApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringcloudLoginApplication.class, args);
    }

3、使用

package com.yl.springcloudlogin.controller;

import com.yl.springcloudlogin.entity.request.UserRegisterReq;
import com.yl.springcloudlogin.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;

/**
 * @Author 向往啊 2457081614@qq.com
 * @Date 2019/07/18 23:33
 * @Version 1.0
 * @package com.yl.springcloudlogin.controller
 */
@Slf4j
@RestController
@RequestMapping(value = "/user")
@Api("用户相关接口")
public class UserController {

    @Autowired
    private UserService userService;


    /**
     *
     * 登录接口
     * @param account
     * @param password
     * @return
     */
    @ApiOperation("用户登录接口")
    @RequestMapping(value = "/login", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
    public String login(@RequestParam("account") String account, @RequestParam("password") String password) {


        return "login sucess";
    }


    @ApiOperation("用户注册接口")
    @RequestMapping(value = "/register", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
    public String register(@RequestBody UserRegisterReq userRegisterReq) {
        userService.registerUser(userRegisterReq);
        return "注册成功";
    }


}

备注：