`

接口文档之 springboot 集成 swagger 和 swagger-bootstrap-ui

 
阅读更多
1.引入jar
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${springfox-version}</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${springfox-version}</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>1.9.6</version>
</dependency>
2,config setting

@Configuration
@EnableSwagger2
@Profile({"dev","prod"})
public class SwaggerDocumentationConfig implements WebMvcConfigurer {
    ApiInfo apiInfo() {
        return new ApiInfoBuilder().title(xxxxxxx").description("有关HTTP Status Code的说明如下:\r\n"
+ "1. 200: 请求处理成功。再根据返回json中的errCode字段判断操作是否成功。若errCode0,说明操作成功。不同的接口会返回不同的data信息。若errCode不为0,说明请求失败;\r\n"
+ "2. 400: 请求的参数不正确;\r\n" + "3. 401: 用户未登录;\r\n" + "4. 403: 无权限访问;\r\n" +
                "5. 404: 资源不存在;\r\n"
+ "6. 500: 后台代码错误;\r\n"
+ "7. 100001: 用户不存在;\r\n"
+ "8. 100002: 用户被禁止;\r\n"
+ "9. 100003: 用户密码错误;\r\n"
+ "10. 100006: sn格式错误;\r\n"
+ "11. 100008: sn对应设备不支持远程管理;\r\n"
+ "13. 100010: snmac不匹配;\r\n"
+ "14. 100011: 设备已绑定;\r\n"
+ "15. 100012: 新增设备失败;\r\n"
+ "16. 100013: 特征码不合法;\r\n"
+ "17. 100014: 特征码状态更新失败;\r\n"
+ "18. 100015: 特征码已使用、错误或不存在;\r\n"
+ "19. 100016: 用户标签已存在;\r\n"
+ "20. 100017: 新增用户标签失败;\r\n"
+ "21. 100018: 删除用户标签失败;\r\n"
+ "22. 100019: 删除用户标签不存在;\r\n"
+ "23. 100020: 设备不存在;\r\n"
+ "24. 100021: websocket发送数据错误;\r\n"
+ "25. 100022: 上传文件为空;\r\n"
+ "26. 100023: 上传文件格式错误;\r\n"
+ "27. 100024: 上传文件过大;\r\n"
+ "28. 100025: 文件未发现;\r\n"
+ "29. 100026: 下载文件失败;\r\n"
+ "30. 100027: 设备离线;\r\n"
+ "31. 100028: 设备推送数据错误;\r\n"
+ "32. 100029: 添加设备标签失败;\r\n"
+ "33. 100030: 设备标签已到最大数量;\r\n"
+ "\r\n"
+ "管理员登录账号:mythware_admin,密码:123456; \r\n"
+ "\r\n WebSocket发送命令格式:{ snList:[], cmdList:[], id:token }")
                .termsOfServiceUrl("").version("1.0.0").build();
}

    @Bean
public Docket customImplementation() {
        ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
tokenPar.name(Constants.HEADER_AUTH).description("登录令牌").modelRef(new ModelRef("string"))
                .parameterType("header").required(false).build();
pars.add(tokenPar.build());
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(RequestHandlerSelectors.basePackage("com.screencast.web.controller")).build()
                .globalOperationParameters(pars).directModelSubstitute(Date.class, Long.class).apiInfo(apiInfo());
}

  



3排除静态文件
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

4,查看文档
http://127.0.0.1:8089/doc.html


分享到:
评论

相关推荐

    swagger-bootstrap-ui-1.9.6-API文档-中文版.zip

    赠送原API文档:swagger-bootstrap-ui-1.9.6-javadoc.jar; 赠送源代码:swagger-bootstrap-ui-1.9.6-sources.jar; 赠送Maven依赖信息文件:swagger-bootstrap-ui-1.9.6.pom; 包含翻译后的API文档:swagger-...

    springboot集成swagger-bootstrap-ui.doc

    springboot集成swagger-bootstrap-ui,这是一个生成接口文档的一个框架。

    springboot整合swagger-bootstrap-ui,过滤器放开并解决自定义错误信息返回冲突-DEMO

    springboot整合swagger-bootstrap-ui,过滤器放开并解决自定义错误信息返回冲突-DEMO

    swagger-bootstrap-ui-1.9.6-API文档-中英对照版.zip

    赠送原API文档:swagger-bootstrap-ui-1.9.6-javadoc.jar; 赠送源代码:swagger-bootstrap-ui-1.9.6-sources.jar; 赠送Maven依赖信息文件:swagger-bootstrap-ui-1.9.6.pom; 包含翻译后的API文档:swagger-...

    基于Java的knife4j与swagger-bootstrap-ui集成框架示例项目设计源码

    本源码提供了一个基于Java的knife4j与swagger-bootstrap-ui集成框架示例项目设计。...这个项目是一个集成框架示例项目,可能包括API文档的生成、展示等功能,适合用于需要集成knife4j和swagger-bootstrap-ui的场景。

    swagger-bootstrap-ui

    Swagger Bootstrap UI 是一个基于Bootstrap框架对Swagger UI进行重新设计和增强的项目,旨在提供更加美观、易用且功能丰富的API文档界面。Swagger是业界广泛使用的API文档规范和工具,而Bootstrap则是流行的前端UI库...

    Swagger 自定义UI界面.doc

    Swagger 自定义UI界面 Swagger 是一个流行的 API 文档生成工具,能够自动生成 RESTful API 的...我们使用了两个库:swagger-ui-layer 和 swagger-bootstrap-ui,提供了多种主题和布局样式,满足了不同开发者的需求。

    111-springboot-demo-swagger-v2-bootstrap-ui.rar

    当接口更新之后,只需要修改代码中的 Swagger 描述就可以实时生成新的接口文档了,从而规避了接口文档老旧不能使用的问题;通过 Swagger 页面,我们可以直接进行接口调用,降低了项目开发阶段的调试成本。Swagger3...

    springboot 分布式系统swagger文档spring-boot-swagger-distributed-demo

    该项目利用了基于springboot + vue + mysql的开发模式框架实现的课设系统,包括了项目的源码资源、sql文件、相关指引文档等等。 【项目资源】:包含前端、后端、移动开发、操作系统、人工智能、物联网、信息化管理...

    在Spring Boot中使用swagger-bootstrap-ui的方法

    在Spring Boot中使用swagger-bootstrap-ui可以提供一个更加友好的API文档和交互方式。本文将介绍在Spring Boot中使用swagger-bootstrap-ui的方法。 首先,需要在pom.xml文件中引入swagger和swagger-bootstrap-ui的...

    SpringBoot集成SwaggerUi以及启动时遇到的错误

    SpringBoot 集成 SwaggerUi 可以帮助我们快速生成接口文档,并且可以用来测试这些接口。但是,在启动时,我们需要注意可能遇到的错误,并且需要仔细地检查我们的配置文件和代码,以确保项目的正确启动。

    针对JFinal制作的Swagger插件,集成最新版swagger-bootstrap-ui,支持文_jfin

    针对JFinal制作的Swagger插件,集成最新版swagger-bootstrap-ui,支持文_jfinal-swagger-junior

    swagger-bootstrap-ui的jar包

    总结来说,Swagger Bootstrap UI 是一个增强型的 Swagger 用户界面,提供了更美观的接口文档展示和自定义端口的能力。其 JAR 包形式便于集成到 Java 项目中,而 "SwaggerRegister" 文件可能是启动和配置 Swagger ...

    SpringBoot整合Swagger2.docx

    ### SpringBoot整合Swagger2知识点详解 #### 一、Swagger2简介与作用 Swagger 是一个规范和完整的框架,...通过以上步骤,我们可以在 SpringBoot 项目中成功集成 Swagger2,为后续的开发、测试以及文档管理提供便利。

    swagger-bootstrap-ui:Swagger-bootstrap-ui是Swagger的前端UI实现,目的是替换Swagger的默认UI实现Swagger-UI,使文档更加友好...

    文档:根据Swagger的规范,列出了接口文档的详细说明,包括接口地址,类型,请求示例,请求参数,响应示例,响应参数,响应代码和其他信息。 通过使用swagger-bootstrap UI,它可以清楚地了解此接口的用法。 在线...

    Laravel开发-swagger-ui-lumen

    在本文中,我们将深入探讨如何在 Laravel 开发环境中集成 Swagger-UI 与 Lumen 微服务框架,以创建一个强大的 API 文档系统。Swagger-UI 是一个流行的工具,用于展示和测试基于 OpenAPI 规范的 RESTful API,而 ...

    113-springboot-demo-knife4j-v2.rar

    本质是Swagger的增强解决方案,前身只是一个SwaggerUI(swagger-bootstrap-ui)Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案, 前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,...

    113-springboot-demo-knife4j-v3.rar

    本质是Swagger的增强解决方案,前身只是一个SwaggerUI(swagger-bootstrap-ui)Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案, 前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,...

    SpringBoot搭建API文档插件Swagger并美化.docx

    总的来说,SpringBoot结合Swagger和Swagger Bootstrap UI提供了一种高效且直观的方式来管理和展示API文档,提高了开发效率和用户体验。确保正确配置并适时更新文档,对于任何提供RESTful服务的项目来说都是至关重要...

Global site tag (gtag.js) - Google Analytics