zoukankan      html  css  js  c++  java
  • Swagger服务API治理详解

    swager2的简介

    App后端开发中经常需要对移动客户端(AndroidiOS)提供RESTful API接口,在后期版本快速迭代的过程中,修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,除非有严格的管理机制,不然很容易导致代码与接口文档不一致现象。

    RESTful API的重磅好伙伴Swagger2,它可以轻松的整合到Spring生态链中,并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量,同时又将说明内容整合入实现代码中,让维护文档和修改代码整合为一体,方便让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API

    添加Swagger2依赖

    pom.xml中加入Swagger2的依赖,目前引用的是最新的release版本:2.7.0

    <dependency>

      <groupId>io.springfox</groupId>

      <artifactId>springfox-swagger2</artifactId>

      <version>2.7.0</version>

    </dependency>

    <dependency>

      <groupId>io.springfox</groupId>

      <artifactId>springfox-swagger-ui</artifactId>

      <version>2.7.0</version>

    </dependency>

    Swagger2配置类

    其中有几个参数需要说明一下:

    SWAGGER_SCAN_BASE_PACKAGE:所在微服务的web目录

    ApiInfo主要是微服务的一些系统级别的配置

    参数

    说明

    title

    微服务标题

    description

    微服务的描述信息

    license

    许可证(按照这个配置即可)

    version

    微服务版本号

    contract

    微服务开发者联系方式,配置完成后,如有问题,可以给微服务开发人员发送邮件

    Docket是创建swagger的配置信息(可以进行分组,目前没有添加)

    关于这块内容,大家可以参考这篇文章:

    http://blog.csdn.net/top_code/article/details/54023136

    controller的编写

     

    swaggeryml中的配置:

    打包Spring Boot程序并启动,打开浏览器访问:http://localhost:8080/swagger-ui.html,就能看到前文所展示的RESTful API的页面。

  • 相关阅读:
    JDBC进行Oracle数据库操作。
    java数据库编程:使用元数据分析数据库
    Java事务处理总结
    TCP、UDP数据包大小的限制
    Java SWT编程基础
    Win7窗口最大化和最小化快捷键
    CentOS7 yum 安装mysql 5.6
    mybatis简介
    mybatis中mysql和oracle的差异
    Java 11 将至,不妨了解一下 Oracle JDK 之外的版本
  • 原文地址:https://www.cnblogs.com/gslblog/p/7906280.html
Copyright © 2011-2022 走看看