3.SpringBoot+Swagger

最新推荐文章于 2022-11-18 18:01:14 发布

威_j

最新推荐文章于 2022-11-18 18:01:14 发布

阅读量177

点赞数

分类专栏： springboot

本文链接：https://blog.csdn.net/Ruo_wei/article/details/100520001

版权

springboot 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

效果图

1.在pom.xml中配置swagger所需要的jar包

           <!-- 引入springboot依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

         <dependency><!--添加Swagger依赖 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency><!--添加Swagger-UI依赖 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency> <!--添加热部署依赖 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>

2.创建swagger配置类

package com.hncg.config;

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration //标记配置类
@EnableSwagger2 //开启在线接口文档
public class Swagger2Config {
	
	  @Bean
	    public Docket createRestApi() {
	        return new Docket(DocumentationType.SWAGGER_2)
	                .apiInfo(apiInfo())
	                .select()
	                .apis(RequestHandlerSelectors.any())
	                .paths(PathSelectors.any())
	                .build();
	    }
	    private ApiInfo apiInfo() {
	        return new ApiInfoBuilder()
	                .title("xxx")//标题
	                .description("description:项目摘要")//描述
	                .termsOfServiceUrl("xxxx")
	                .contact(new Contact("xxx", "xxx", "xxx"))//作者信息
	                .version("6.6.6")//版本号
	                .build();
	    }
}

3.实体类注释

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Users {

	@ApiModelProperty("用户id")
	private Integer uid;
	@ApiModelProperty("用户名")
	private String uname;
	@ApiModelProperty("密码")
	private String upwd;

4.创建controller类测试（以springboot为例）

@Api(value="user",tags="用户管理")
@RestController
@RequestMapping("user")
public class TestController {
	
	@Autowired
	UsersDao usersDao;
	
	@GetMapping("users")
	@ApiOperation(value="查询所有用户信息")
	public List<Users> getUsers(){
		 List<Users>li = usersDao.findAll();
		 li.forEach(user->{
			 System.out.println(user);
		 });
		return li;
	}
	
	@ApiOperation(value="添加用户")
	@ApiImplicitParams({	  //参数描述
		@ApiImplicitParam(name="uname",value="用户名",paramType="query"),
		@ApiImplicitParam(name="upwd",value="密码",paramType="query"),
	})
	@PostMapping("users")
	public void addUser(	
			@RequestParam(name="uname",required=false)String uname, 
			@RequestParam(name="upwd",required=false)String upwd){ 
		System.out.println(uname+"          "+upwd);
	}

启动访问 http://localhost:8080/swagger-ui.html

设置显示为中文：

在src/main/resources目录下创建 META-INF/resources/swagger-ui.html 文件，并替换为以下内容

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Swagger UI</title>
    <link rel="icon" type="image/png" href="webjars/springfox-swagger-ui/images/favicon-32x32.png" sizes="32x32"/>
    <link rel="icon" type="image/png" href="webjars/springfox-swagger-ui/images/favicon-16x16.png" sizes="16x16"/>
    <link href='webjars/springfox-swagger-ui/css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/reset.css' media='print' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/print.css' media='print' rel='stylesheet' type='text/css'/>

    <script src='webjars/springfox-swagger-ui/lib/object-assign-pollyfill.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery.slideto.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery.wiggle.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/handlebars-4.0.5.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/lodash.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/backbone-min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/swagger-ui.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/highlight.9.1.0.pack.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jsoneditor.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/marked.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/swagger-oauth.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/springfox.js' type='text/javascript'></script>

    <!--国际化操作：选择中文版 -->
    <script src='webjars/springfox-swagger-ui/lang/translator.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lang/zh-cn.js' type='text/javascript'></script>

</head>

<body class="swagger-section">
<div id='header'>
    <div class="swagger-ui-wrap">
        <a id="logo" href="http://swagger.io">![](webjars/springfox-swagger-ui/images/logo_small.png)<span class="logo__title">swagger</span></a>
        <form id='api_selector'>
            <div class='input'>
                <select id="select_baseUrl" name="select_baseUrl"></select>
            </div>
            <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
            <div id='auth_container'></div>
            <div class='input'><a id="explore" class="header__btn" href="#" data-sw-translate>Explore</a></div>
        </form>
    </div>
</div>

<div id="message-bar" class="swagger-ui-wrap" data-sw-translate> </div>
<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
</body>
</html>

威_j

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
3.SpringBoot+Swagger

效果图1.在pom.xml中配置swagger所需要的jar包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2<...
复制链接

扫一扫