swagger使用

最新推荐文章于 2023-11-21 19:46:36 发布

lession07

最新推荐文章于 2023-11-21 19:46:36 发布

阅读量178

点赞数 1

文章标签： java

本文链接：https://blog.csdn.net/lession07/article/details/112261011

版权

介绍:
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。
简单来说就是可自动生成前后端交付的文档的工具
官网 : https://swagger.io/tools/
引入pom文件

  <properties>
        <java.version>1.8</java.version>
        <mybatisplus.version>3.3.1</mybatisplus.version>
        <druid.version>1.1.13</druid.version>
        <fastjson.version>1.2.60</fastjson.version>
        <jsonwebtoken.vsersion>0.9.1</jsonwebtoken.vsersion>
        <shiro.version>1.4.0</shiro.version>
        <swagger.version>2.9.2</swagger.version>
    </properties>
 <!-- Swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <!-- 引入swagger-bootstrap-ui包 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>
           <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

配置yml

#swagger2显示或者不显示
swagger:
  show: true

config配置

@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurerAdapter {
    @Value("${swagger.show:true}")
    private boolean swaggerShow;
    @Bean
    public Docket createPcRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerShow)
                .groupName("pc")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.etc.controller"))
                .paths(PathSelectors.any())
                .build().globalOperationParameters(getBean());
    }


    @Bean
    public Docket createPcRestApiOther() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("其他接口")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.etc.controller"))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build().globalOperationParameters(getBean());
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger 接口文档")
                .description("swagger 接口文档")
                .termsOfServiceUrl("******")
                .contact("******")
                .version("1.0")
                .build();
    }

    public  List<Parameter> getBean(){
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        //Token 以及Authorization 为自定义的参数，session保存的名字是哪个就可以写成那个
        ticketPar.name("token").description("token")
                .modelRef(new ModelRef("string")).parameterType("header")
                //header中的ticket参数非必填，传空也可以
                .required(false).build();

        pars.add(ticketPar.build());
        return pars;
    }

controller层

@RestController
@RequestMapping("/test")
@Api(value="测试接口",tags={"开发时，测试使用......"})
public class TestController {
	@Autowired
	private TestServiceImpl testService;

	@PostMapping("/test")
	@ApiOperation(value = "测试获取String")
	String getTest(){
		return this.testService.justATest();
	}

	@GetMapping("/test01")
	@ApiOperation(value = "测试获取String")
	String getTest11(){
		return this.testService.justATest();
	}
}