文档章节

restful文档神器 swagger (1)

任梁荣
 任梁荣
发布于 2015/11/17 15:07
字数 183
阅读 627
收藏 3

功能

自动的在代码中分析REST接口,生成REST接口描述JSON。这个JSON又可以被客户端生成文档,以及测试用的WEB页。
例如:

  • 我有这么一个接口:

    @RequestMapping(value="/{name}", method = RequestMethod.GET)@ResponseBodypublic Movie getMovie(@PathVariable String name)
  • swagger加入以后,会自动生成这样的描述:

    {
        "apiVersion": "1.0",
        "swaggerVersion": "1.0",
        "basePath": "http://localhost:8080",
        "resourcePath": "/movie",
        "apis": [
            {
                "path": "/movie/{name}",
                "description": "",
                "operations": [
                    {
                        "httpMethod": "GET",
                        "summary": "get Movie",
                        "notes": "",
                        "deprecated": false,
                        "responseClass": "Movie",
                        "nickname": "getMovie",
                        "parameters": [
                            {
                                "name": "name",
                                "description": "name",
                                "notes": "",
                                "paramType": "path",
                                "defaultValue": "",
                                "required": false,
                                "allowMultiple": false,
                                "dataType": "String"
                            }
                        ]
                    }
                ]
            }
        ],
        "models": {
            "Movie": {
                "properties": {
                    "name": {
                        "type": "string"
                    },
                    "year": {
                        "type": "string"
                    }
                },
                "type": "Movie"
            }
        }}
  • 然后swagger-ui作为纯HTML+JS的前端,读取上述描述后,可以产生这么一套网页: swagger-ui


© 著作权归作者所有

共有 人打赏支持
任梁荣
粉丝 7
博文 38
码字总数 39659
作品 0
上海
后端工程师
私信 提问
使用Swagger2构建Spring Boot RESTful AIP 文档

上一篇我们介绍了如何使用Spring Boot快速构建RESTful API “Spring Boot与RESTful API ” ,本篇则介绍一个配合Spring Boot快速构建RESTful文档的工具 由于Spring Boot具有快速开发、便捷部...

老虎是个蛋蛋
2016/12/23
1K
5
OpenAPI接口的发布,文档,测试----Swagger+Dubbo Rest+Easyrest

背景 对外开放的接口,需要清晰的接口文档,方便客户端进行测试,目前restful风格的接口定义是最好理解,调用和测试的接口风格;服务提供端也需要一种简单的办法,把已有的服务接口发布为res...

PageYi
2018/10/23
0
0
Yii2+Swagger搭建RESTful风格的API项目

在现有的Advanced Template上搭建RESTful API项目的步骤: 本案例前提说明: 本例中不使用yiirestActiveController自动创建的API,而是自定义一个API 使用Auth2.0的Bearer模式进行身份验证 ...

无上@诀
2016/08/19
0
0
使用swagger 生成 Flask RESTful API

什么是 RESTful 什么是REST REST(英文:Representational State Transfer,又称具象状态传输)是Roy Thomas Fielding博士于2000年在他的博士论文 中提出来的一种万维网软件架构风格,目的是...

goodspeed
2017/07/11
0
0
SpringBoot集成SwaggerUI

Swagger是当前最好用的Restful API文档生成的开源项目,通过swagger-spring项目,实现了与SpingMVC框架的无缝集成功能,方便生成spring restful风格的接口文档,同时swagger-ui还可以测试spr...

黄步欢
2017/05/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

SpringBoot2.x配置Cors跨域

SpringBoot2.x配置Cors跨域 1 跨域的理解 跨域是指:浏览器A从服务器B获取的静态资源,包括Html、Css、Js,然后在Js中通过Ajax访问C服务器的静态资源或请求。即:浏览器A从B服务器拿的资源,...

水木星辰
20分钟前
1
0
一文搞懂TCP与UDP的区别

**摘要:**计算机网络基础 作者:浪里行舟 Fundebug经授权转载,版权归原作者所有。 引言 网络协议是每个前端工程师都必须要掌握的知识,TCP/IP 中有两个具有代表性的传输层协议,分别是 TC...

Fundebug
21分钟前
2
0
Hanlp1.7版本的新增功能一览

Hanlp1.7版本在去年下半年的时候就随大快的DKH1.6版本同时发布了,截至目前1.7大版本也更新到了1.7.1了。本篇分别就1.7.0和1.7.1中新增的功能做一个简单的汇总介绍。 HanLP 是由一系列模型与...

左手的倒影
29分钟前
1
0
Linux之PAM可动态加载的认证模块

在Linux中执行有些程序时,这些程序在执行前首先要对启动它的用户进行认证,符合一定的要求之后才允许执行,例如login, su等。在Linux中进行身份或是状态的验证程序是由PAM来进行的,PAM(P...

城市之雾
29分钟前
1
0
程序员接私活那些坑

前言 最近有很多人问我私活怎么样?有什么坑,我之前也是接了几个私活,当然也有稳定的收入。我们也来分享一下。前几天发现了一个帖子很不错,我们来分享一下 注:本文转自 : http://blog.cs...

终端研发部
37分钟前
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部