栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

从spring boot到spring cloud(九)接口调试Swagger

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

从spring boot到spring cloud(九)接口调试Swagger

在开发过程中写完接口以后免不了要做接口测试,很多时候都是使用第三方请求程序做测试。在很多时候使用起来不方便,或者很多情况下是禁止互联网的。那么就出现了可集成springboot的接口测试框架Swagger

maven方式新建springboot项目

pom.xml



	4.0.0
	
		org.springframework.boot
		spring-boot-starter-parent
		2.5.7
		 
	
	com.wjxt
	wjxt
	0.0.1-SNAPSHOT
	wjxt
	Demo project for Spring Boot
	
		1.8
	
	
		
			org.springframework.boot
			spring-boot-starter-web
		
		
			com.alibaba
			druid-spring-boot-starter
			1.1.10
		
		
			org.mybatis.spring.boot
			mybatis-spring-boot-starter
			2.2.2
		
		
            org.springframework.boot
            spring-boot-starter-web
        
		
            org.springframework.boot
            spring-boot-starter-web
        
        
            io.springfox
            springfox-boot-starter
            3.0.0
    	
    	
            com.github.xiaoymin
            swagger-bootstrap-ui
            1.9.6
        
		
			mysql
			mysql-connector-java
			runtime
		
		
			org.springframework.boot
			spring-boot-starter-test
			test
		
		
            com.auth0
            java-jwt
            3.4.0
        
	

	
		
			
				org.springframework.boot
				spring-boot-maven-plugin
			
		
	


主要引入是

      
            com.github.xiaoymin
            swagger-bootstrap-ui
            1.9.6
       

配置Swagger参数

新建Swagger配置类

package com.wjxt.Swagger;

import java.util.ArrayList;
import java.util.List;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.v3.oas.annotations.Parameter;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
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 swagger3 {

    
    @Bean
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("系统  API")
                .description("系统 api")
                .termsOfServiceUrl("#")
                .contact(new Contact("测试工具","#","18379287@qq.com"))
                .version("1.0")
                .build();
    }

    
    @Bean
    public Docket createRestApi(ApiInfo apiInfo) {

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .groupName("用户接口")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wjxt.controller"))
                .paths(PathSelectors.ant("/user/**"))
                .build()// 指定全局参数
                ;
    }
    @Bean
    public Docket createRestApi1(ApiInfo apiInfo) {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .groupName("系统接口")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wjxt.controller"))
                .paths(PathSelectors.ant("/systempc/**"))
                .build();
    }

}

主要用于配置说明

 

 主要用于分组,当项目开发到后期接口多了以后区分很麻烦,所以可以把不同的接口做分组处理。

测试接口

	@RequestMapping(value="/login",method = RequestMethod.POST)
	@ResponseBody
	@ApiOperation("登录接口")
	public aqjyxt_user login(HttpServletRequest request,aqjyxt_user aqjyxt_user) {
		
		return aqjyxt_user;

	}

@RequestMapping(value="/login",method = RequestMethod.POST) //设置只显示post选项

@ApiOperation("登录接口")//设置swagger中接口显示的描述

aqjyxt_user对象类

package com.wjxt.entity;

public class aqjyxt_user {

    private String id;

    private String user;

    private String password;

    private String username;

    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id == null ? null : id.trim();
    }
    public String getUser() {
        return user;
    }

    public void setUser(String user) {
        this.user = user == null ? null : user.trim();
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password == null ? null : password.trim();
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username == null ? null : username.trim();
    }
}
启动服务测试接口

启动服务以后输入

http://127.0.0.1:8085/swagger-ui/index.html#/

 swagger自带的ui实在太丑了,一开始导入的插件其实就是swagger-bootstrap-ui。可以直接访问

http://127.0.0.1:8085/doc.html

很多时候我们的token是存放在头文件中的,怎么添加头文件参数呢?

可以在文档管理--全局参数设置中添加头文件

那么swagger的配置到这里就结束了。 

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/955946.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号