swagger-ui教程-构建api接口文档工具

最新推荐文章于 2024-08-01 16:16:02 发布

不断学习的ITer

最新推荐文章于 2024-08-01 16:16:02 发布

阅读量1w

点赞数

分类专栏：自动化测试

自动化测试专栏收录该内容

15 篇文章 0 订阅

订阅专栏

Swagger UI是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。demo参见：http://petstore.swagger.wordnik.com/#!/pet

功能

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

我有这么一个接口：

@RequestMapping(value="/{name}", method = RequestMethod.GET)
@ResponseBody
public 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"
        }
    }
}