• UID20532
  • 登录2018-02-12
  • 粉丝0
  • 关注0
  • 发帖119
  • 主页
  • 金币333枚
swiftie 发布于2018-02-07 15:37
0/44

企业级 SpringCloud 教程 (九) 服务链路追踪(Spring Cloud Sleuth)

楼层直达
swagger,中文“拽”的意思。它是一个功能强大的api框架,它的集成非常简单,不仅提供了在线文档的查阅,而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api,简单优雅帅气,正如它的名字。
一、引入依赖


        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

二、写配置类




@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.forezp.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格,http://blog.csdn.net/forezp")
                .termsOfServiceUrl("http://blog.csdn.net/forezp")
                .version("1.0")
                .build();
    }
}


通过@Configuration注解,表明它是一个配置类,@EnableSwagger2开启swagger2。apiINfo()配置一些基本的信息。apis()指定扫描的包会生成文档。
三、写生产文档的注解
swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。
  • @Api:修饰整个类,描述Controller的作用
  • @ApiOperation:描述一个类的一个方法,或者说一个接口
  • @ApiParam:单个参数描述
  • @ApiModel:用对象来接收参数
  • @ApiProperty:用对象接收参数时,描述对象的一个字段
  • @ApiResponse:HTTP响应其中1个描述
  • @ApiResponses:HTTP响应整体描述
  • @ApiIgnore:使用该注解忽略这个API
  • @ApiError :发生错误返回的信息
  • @ApiParamImplicitL:一个请求参数
  • @ApiParamsImplicit 多个请求参数

现在通过一个栗子来说明:



package com.forezp.controller;

import com.forezp.entity.Book;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;

import java.util.*;

/**
 * 用户创建某本图书 POST    /books/
 * 用户修改对某本图书    PUT /books/:id/
 * 用户删除对某本图书    DELETE  /books/:id/
 * 用户获取所有的图书 GET /books
 *  用户获取某一图书  GET /Books/:id
 * Created by fangzhipeng on 2017/4/17.
 * 官方文档:http://swagger.io/docs/specification/api-host-and-base-path/
 */
@RestController
@RequestMapping(value = "/books")
public class BookContrller {

    Map<Long, Book> books = Collections.synchronizedMap(new HashMap<Long, Book>());

    @ApiOperation(value="获取图书列表", notes="获取图书列表")
    @RequestMapping(value={""}, method= RequestMethod.GET)
    public List<Book> getBook() {
        List<Book> book = new ArrayList<>(books.values());
        return book;
    }

    @ApiOperation(value="创建图书", notes="创建图书")
    @ApiImplicitParam(name = "book", value = "图书详细实体", required = true, dataType = "Book")
    @RequestMapping(value="", method=RequestMethod.POST)
    public String postBook(@RequestBody Book book) {
        books.put(book.getId(), book);
        return "success";
    }
    @ApiOperation(value="获图书细信息", notes="根据url的id来获取详细信息")
    @ApiImplicitParam(name = "id", value = "ID", required = true, dataType = "Long",paramType = "path")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public Book getBook(@PathVariable Long id) {
        return books.get(id);
    }

    @ApiOperation(value="更新信息", notes="根据url的id来指定更新图书信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "图书ID", required = true, dataType = "Long",paramType = "path"),
            @ApiImplicitParam(name = "book", value = "图书实体book", required = true, dataType = "Book")
    })
    @RequestMapping(value="/{id}", method= RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody Book book) {
        Book book1 = books.get(id);
        book1.setName(book.getName());
        book1.setPrice(book.getPrice());
        books.put(id, book1);
        return "success";
    }
    @ApiOperation(value="删除图书", notes="根据url的id来指定删除图书")
    @ApiImplicitParam(name = "id", value = "图书ID", required = true, dataType = "Long",paramType = "path")
    @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id) {
        books.remove(id);
        return "success";
    }

    @ApiIgnore//使用该注解忽略这个API
    @RequestMapping(value = "/hi", method = RequestMethod.GET)
    public String  jsonTest() {
        return " hi you!";
    }
}


通过相关注解,就可以让swagger2生成相应的文档。如果你不需要某接口生成文档,只需要在加@ApiIgnore注解即可。需要说明的是,如果请求参数在url上,@ApiImplicitParam 上加paramType = “path” 。
启动工程,访问:http://localhost:8080/swagger-ui.html ,就看到swagger-ui:

整个集成过程非常简单,但是我看了相关的资料,swagger没有做安全方面的防护,可能需要我们自己做相关的工作。
架构代码如下:



 


资料和源码来源地址

0人打赏
您需要登录后才可以回帖
发表回复
极贡献
技术问答
专题荟萃
程序人生
视觉设计
Android开发
iOS开发
编程语言
前端开发
后端开发
服务器架构
软件测试
运维方案
创业路上



最热文章墙

  • 84644/384   【精品推荐】200多种Android动画效果的强悍框架,太全了,不看这个,再有动画的问题,不理你了^@^

  • 48394/191   情人节福利,程序员表白的正确姿势:改几行代码就变成自己的表白了

  • 46909/0   Python爬虫:常用浏览器的useragent

  • 44075/261   【精品推荐】Android版产品级的音乐播放器源码,功能太强大了,最好的产品原型有木有?

  • 40463/145   省时省力的Android组件群来了,非常棒的原型参考

  • 32138/143   2016抢红包软件及源码

  • 30466/71   原创表白APP,以程序员的姿势备战新年后的7夕,持续完善中!

  • 29809/2   超全!整理常用的iOS第三方资源

  • 26210/161   Android版类似UC浏览器:非常赞,产品级的源码

  • 23613/31   麻省理工的一帮疯子,真的实现了随意操控万物!(绝对黑科技)

  • 23370/27   2016程序员跳槽全攻略

  • 23346/26   Android工程师面试题大全

  • 22466/10   GitHub上排名前50的iOS项目:总有一款你用得着

  • 21581/21   码魂:程序员的牛B漫画

  • 20244/74   【持续更新中】Android福利贴(二):资料源码大放送

  • 20018/85   Android小而全的博客源码:非常适合全面掌握开发技巧

  • 19890/43   一个绚丽的loading动效分析与实现!

  • 19430/10   2016年最全的Android面试考题+答案 精编版

  • 19328/3   吐槽那些程序员的搞笑牛逼注释

  • 18859/104   Android带弹幕的视频播放器源码,来自大名鼎鼎的Bilibili弹幕网站

  • 18599/45   惊艳的App引导页:背景图片切换加各个页面动画效果

  • 18562/82   仿京东商城客户端Android最新版,不错的原型和学习资料

  • 18115/1   iOS 动画总结

  • 17999/25   个人收集的Android 各类功能源代码

  • 17765/23   Android福利第三波【Android电子书】

  • 17589/81   【精品推荐】类似360安全卫士安Android源码:非常赞的产品原型

  • 17480/5   新一代Android渠道打包工具:1000个渠道包只需要5秒

  • 17456/1   iOS中文版资源库,非常全

  • 17331/54   基于瀑布流的美女图片浏览App,有注释的源代码

  • 17039/18   用JavaScript 来开发iOS和Android 原生应用:React Native开源框架中文版来啦

  • 16830/10   女程序员的梦,众网友的神回复

  • 16797/23   珍藏多年的素材,灵感搜寻网站

  • 16669/19   65条最常用正则表达式,你要的都在这里了

  • 16659/11   年会上现场review代码是怎么样的体验!

  • 15383/16   基于Android支付宝支付设计和开发方案

  • 15033/18   什么是真正的黑客:收获12200+Stars,人气远超微软开源VS

  • 14903/11   有木有这样一张酷图帮你集齐所有git命令超实用

  • 14871/62   【技巧一】搭配Android Studio,如何实现App远程真机debug?

  • 14817/4   46 个非常有用的 PHP 代码片段

  • 14789/47   在线音乐播放器完整版(商用级的源码):非常赞,可听免费高品质专辑

  • 14187/0   GitHub iOS 库和框架Top100 

  • 14024/7   用程序员的姿势抢过年的火车票

  • 13987/7   一张图搞定iOS学习路线,非常全面

  • 13625/10   成为Java顶尖程序员 ,看这11本书就够了

  • 13593/10   微信支付终于成功了(安卓,iOS),在此分享

  • 13497/18   一张图搞定Android学习路线,非常全面

  • 13439/29   【持续更新中】Android福利贴(一):资料源码

  • 13259/4   基于Node.js的强大爬虫,能直接发布抓取的文章哦

  • 12508/3   即时通信第三方库

  • 12408/1   基于node-webkit跨平台应用案例集之(一)

  • 11988/9   流媒体视频直播方案

  • 11980/18   八个最优秀的Android Studio插件

  • 11746/9   B站建开源工作组:APP想支持炫酷弹幕的看过来

  • 11724/2   【精品推荐】高质量PHP代码的50个实用技巧:非常值得收藏

  • 11457/9   烧了5亿美金,这家神秘的公司即将颠覆人类未来!

  • 11421/12   中国黑客的隐秘江湖:攻守对立,顶尖高手月入千万美元

  • 10841/0   过上惬意生活的精华资源:创业、工作、生活成长

  • 10673/6   开箱即用!Android四款系统架构工具

  • 10570/2   Android性能优化视频,文档以及工具

  • 10468/4   10款GitHub上最火爆的国产开源项目——可以媲美西半球

  • 返回顶部