caspar-chen / swagger-ui-layer Goto Github PK
View Code? Open in Web Editor NEW基于swagger的漂亮的接口文档
License: Apache License 2.0
基于swagger的漂亮的接口文档
License: Apache License 2.0
作者辛苦了,required必填项没有校验
以json格式提交数据:{"a":"小小","id":"id","title":"标题"},后台收到的值为:a=%E5%B0%8F%E5%B0%8F&id=id&title=%E6%A0%87%E9%A2%98,使用Postman正常
对于文件上传没有兼容
比如我打开网址:http://localhost:8080/project/docs.html.
里面有个mapper是persons。
如果直接在浏览器访问http://localhost:8080/project/persons,就能够得到结果。
但是在ui里点击这个接口的debug就404,因为发出的url是http://localhost:8080/persons。怎么解决
springfox的swagger-ui会展示成删除线的样式。
如题。token通常在头部的Authrazation里。调试页面允许填这个就会好很多。
PS:谢谢作者的工作。的确比swagger-ui好看很多。
例如下代码,data是一个实体类,实体的注释无法显示了
@apimodel("返回响应数据ResponseResult")
public class ResponseResult {
@ApiModelProperty("错误码,1成功 0失败")
private int code;
@ApiModelProperty("执行结果描述")
private String desc;
@ApiModelProperty("版本")
private String version;
@ApiModelProperty("数据")
private T data;
1、RequestMethod的类型为post以及put的restful接口其Responses为空白?
2、即便在接口使用@ApiResponses或者@ApiResponse,接口界面也是显示为空白,源码的BUG?
当参数类型错误,返回无数据
这个页面布局,正是我们项目组期望已久的!但是有个疑问,现在一般都是docker直接执行nodejs环境吧?那种情况下面,怎样来部署您的这个页面布局呢?
框架用的是Spring Boot 2.0
swagger-ui (2.8.0)和 swagger-ui-layer (0.0.4) 也都是用的最新版本
swagger-ui用 /swagger-ui.html
可以正常访问,/v2/api-docs
也可以正常返回结果
但是访问swagger-ui-layer,提示
No mapping found for HTTP request with URI [/docs.html] in DispatcherServlet with name 'dispatcherServlet'
请问应该设置哪里呢?
示例:
@ApiOperation(value = "测试接口", notes = "测试接口",httpMethod = "POST",consumes = "application/json;charset=UTF-8")
debug时仍旧可以选择form与json,期望ApiOperation定义consumes后仅保留json。
如图,谷歌浏览器调试模式中 Network 可以看到请求已经发出,且返回结果正常,但页面无反应。
用的 @RestController,所以无需 @responsebody。
大佬 能不能优化一下
建議請求失敗時,也將返回內容顯示在頁面中(Responses下方),現在使用彈出dialog顯示不方便。
拦截器中如何配置放行呢?
如题,
后端接口的body体为json格式。
前端切换为json格式后,提交时payload依然是键值对。
对API进行分组。如何才能使用groupname?
引入的spring4all的swagger-spring-boot-starter依赖
比如返回json对象
{"code":200,"msg":"消息","data":{"id":1,"userName":"admin"}}
显示出来的效果为
Properties | Type | Description |
---|---|---|
code | integer | 描述 |
data | object | 描述 |
msg | string | 描述 |
//从URL获取参数
function getQueryString (name) {
return decodeURIComponent((new RegExp('[?|&]'+name+'='+'([^&;]+?)(&|#|;|$)').exec(location.href)||[, ''])[1].replace(/+/g, '%20')) || null
}
var url = "v2/api-docs";
//获取group的值
if(getQueryString("group")) {
url += "?group=" + getQueryString("group");
}
修改docs.js中的ajax地址为上面的url,不知道管理有这样尝试过没
不好调试哦还有上传的类型无法测试
本想打算用这个ui替换原生ui结果发现跟原生ui相比虽然整体上要好看一些,但同样存在不少地方反而比不上原生ui,最终暂时放弃对原生的替换。
主要问题如下:
1、@ApiModelProperty设置example参数无效,无法提供默认查询示例
2、debug中json参数只能自行输入,而原生ui只需要点击默认示例即可
3、原生ui在每次点击对应接口后url会发生变化,而swagger-ui-layer所有接口显示的url都一样,导致刷新页面后需要重新查找之前的接口
以上问题导致再开发和测试时使用反而不如原生ui好用,建议以后改进
另外建议添加对接口排序的支持。
form 提交请求参数时,Request URL 中会将参数拼接两次
如提交请求参数:
module=asd
则 Request URL为:
http://suldemo.tianox.com/banner?module=asd&module=asd
Uncaught TypeError: Cannot read property 'url' of undefined
at Function.eval [as fn] (eval at L (jsrender.min.js:3), :19:24)
at F (jsrender.min.js:3)
at Function.S [as render] (jsrender.min.js:3)
at m.fn.init.Z [as render] (jsrender.min.js:3)
at Object.success (docs.js:24)
at j (jquery.js:2)
at Object.fireWith [as resolveWith] (jquery.js:2)
at x (jquery.js:4)
at b (jquery.js:4)
at Object.send (jquery.js:4)
0.0.2版本升级到1.1.3之后,重新启动应用,报404,访问http://localhost:8193/docs.html报404,我的应用的端口起的就是8193
主要是少了两个dev加ayui-tab-item嵌套导致的,附上源码有点乱,给取消了,大家可以自己手动改下
返回的数据类型中有LocalDateTime类型的,对这个字段使用@jsonformat转换成字符串格式显示之后,但是在ui界面还是显示的是没有转换之前的LocalDateTime的格式
如题
案例:
{
"get": {
"summary": "第一个list功能",
"deprecated": false,
"produces": [
"*/*"
],
"operationId": "list3GET4997028859787988992",
"responses": {
"200": {
"schema": {
"type": "object",
"properties": {
"id": {
"name": "id",
"in": "formData",
"description": "标识的desc",
"required": true,
"type": "string"
},
"createTime": {
"name": "createTime",
"in": "formData",
"description": "时间的desc",
"required": false,
"type": "string"
}
}
},
"description": "返回profile列表"
}
},
"description": "list的description",
"parameters": [
{
"name": "id",
"in": "formData",
"description": "标识的desc",
"required": true,
"type": "string"
},
{
"name": "createTime",
"in": "formData",
"description": "时间的desc",
"required": false,
"type": "string"
}
],
"tags": [
"profile"
],
"consumes": [
"application/xml"
]
}
}
在responses里面的schema不能正确的展示。 该问题在springfox-swagger-ui等其他工具上可以正确展示。如果schema内容为$ref指到definitions内的元素,展示没有问题。
例如,{"$ref":"#/definitions/WxJsapiSignature"},这种类型在UI中没有处理,恳求作者能够增加。
怎么改成中文??
比如debug下需要token的支持 设置了全局的头部token后,在这个项目里无法显示。每次还要重新输入。希望您加上。这个版本超赞!!!!
没有原生的Authorize这个鉴权的东西,能否添加呢
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.