配置增强swagger


<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>${org.springdoc.version}</version>
</dependency>

 

Swagger版本要与springboot  版本对应

2.1.0 ->3.1.2

<org.springdoc.version>2.1.0</org.springdoc.version>

地址:http://localhost:8090/swagger-ui/index.html

image

增强版

swagger扩展框架 之knife4j

<knife4j.version>4.3.0</knife4j.version>

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>${knife4j.version}</version>
</dependency>


地址:http://localhost:8090/doc.html#/home

image

配置

# springdoc-openapi项目配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.example.activiti.controller
# knife4j的增强配置,不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: en

Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j (xiaominfo.com)

image

 


 

SpringBoot2.2.6 整合 Swagger2文档 使用BootstrapUI页面

参考:http://t.csdnimg.cn/EMvSi

引入依赖


		<swagger-ui.version>2.9.2</swagger-ui.version>
        <swagger2.version>2.9.2</swagger2.version>
        <swagger-bootstrap-ui.version>1.8.5</swagger-bootstrap-ui.version>
<span class="hljs-comment">&lt;!-- swagger-ui --&gt;
    <span class="hljs-tag">&lt;<span class="hljs-name">dependency&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">groupId&gt;io.springfox<span class="hljs-tag">&lt;/<span class="hljs-name">groupId&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">artifactId&gt;springfox-swagger-ui<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">version&gt;${swagger-ui.version}<span class="hljs-tag">&lt;/<span class="hljs-name">version&gt;
    <span class="hljs-tag">&lt;/<span class="hljs-name">dependency&gt;
    <span class="hljs-comment">&lt;!-- swagger2 --&gt;
    <span class="hljs-tag">&lt;<span class="hljs-name">dependency&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">groupId&gt;io.springfox<span class="hljs-tag">&lt;/<span class="hljs-name">groupId&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">artifactId&gt;springfox-swagger2<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">version&gt;${swagger2.version}<span class="hljs-tag">&lt;/<span class="hljs-name">version&gt;
    <span class="hljs-tag">&lt;/<span class="hljs-name">dependency&gt;
    <span class="hljs-comment">&lt;!-- 引入swagger-bootstrap-ui包 --&gt;
    <span class="hljs-tag">&lt;<span class="hljs-name">dependency&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">groupId&gt;com.github.xiaoymin<span class="hljs-tag">&lt;/<span class="hljs-name">groupId&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">artifactId&gt;swagger-bootstrap-ui<span class="hljs-tag">&lt;/<span class="hljs-name">artifactId&gt;
        <span class="hljs-tag">&lt;<span class="hljs-name">version&gt;${swagger-bootstrap-ui.version}<span class="hljs-tag">&lt;/<span class="hljs-name">version&gt;
    <span class="hljs-tag">&lt;/<span class="hljs-name">dependency&gt;


加入SwaggerConfig配置类

package com.cibn.boss.order.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**

  • SwaggerConfig

  • @desc: Swagger配置

  • @version:

  • @createTime: 2020/8/06 14:36

  • @author:
    */
    @Configuration
    public class SwaggerConfig {

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

    private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
    .title("海外boss api文档")
    .description("restful 风格接口")
    .version("1.0")
    .build();
    }

}


启动类

package com.cibn.boss.order;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwaggerBootstrapUI
@EnableSwagger2
@SpringBootApplication
@MapperScan(value = "com.cibn.boss.order.dao")
public class BossAppcation {
public static void main(String[] args)
{
SpringApplication.run(BossAppcation.class, args);

}

}


访问页面: http://ip:端口号/doc.html

posted @ 2023-12-25 09:45  你今日食咗饭未  阅读(75)  评论(0)    收藏  举报