前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Swagger 2 的配置与使用(亲测有效)

Swagger 2 的配置与使用(亲测有效)

作者头像
一写代码就开心
发布2022-08-23 15:35:57
5690
发布2022-08-23 15:35:57
举报
文章被收录于专栏:java和pythonjava和python

目录

1 需求

我们自己的springboot项目,想要集成swagger2,

2 集成步骤

1 在我们的springboot项目里面导入依赖

代码语言:javascript
复制
  <swagger.version>2.9.2</swagger.version>
  <swagger-bootstrap-ui.version>1.9.6</swagger-bootstrap-ui.version>


   <!-- swagger2-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>${swagger.version}</version>
            </dependency>
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>swagger-bootstrap-ui</artifactId>
                <version>${swagger-bootstrap-ui.version}</version>
            </dependency>

2 写配置文件

在yml里面写好一些基本的配置

代码语言:javascript
复制
# swagger配置
swagger:
  title: '数据服务接口文档'
  base:
    package: com.jing.controller
  description: '数据服务接口文档'
  url: ''
  contact:
    name:
    email:
    url: ''
  version: 1.0

3 写一个配置类,将yml里面的东西导入

代码语言:javascript
复制
@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    /**
     * 标题
     */
    @Value("${swagger.title}")
    private String title;

    /**
     * 基本包
     */
    @Value("${swagger.base.package}")
    private String basePackage;

    /**
     * 描述
     */
    @Value("${swagger.description}")
    private String description;

    /**
     * URL
     */
    @Value("${swagger.url}")
    private String url;

    /**
     * 作者
     */
    @Value("${swagger.contact.name}")
    private String contactName;

    /**
     * 作者网址
     */
    @Value("${swagger.contact.url}")
    private String contactUrl;

    /**
     * 作者邮箱
     */
    @Value("${swagger.contact.email}")
    private String contactEmail;

    /**
     * 版本
     */
    @Value("${swagger.version}")
    private String version;

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(url)
                .contact(new Contact(contactName, contactUrl, contactEmail))
                .version(version)
                .build();
    }
}

4 启动项目,访问

代码语言:javascript
复制
http://192.168.1.12:8083/doc.html
在这里插入图片描述
在这里插入图片描述
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022-08-21,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 目录
  • 1 需求
  • 2 集成步骤
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档