文档章节

api文档自动生成 -swagger ui

洞渊龙王
 洞渊龙王
发布于 2016/08/26 11:19
字数 294
阅读 422
收藏 3

swagger ui

@Bean
	public Docket testApi(){
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("v0.0.1")
				.genericModelSubstitutes(DeferredResult.class)
				.useDefaultResponseMessages(false)
				.forCodeGeneration(true)
				.pathMapping("/test")
				.select()
				.paths(PathSelectors.regex("/common/.*"))
				.build()
				.apiInfo(testApiInfo());
	}


解析:

docket (摘要) 文档类型我们使用了SWAGGER_2这个
	groupName 每一个组的名称,
	
	genericModelSubstitutes (通用模型替换)
			deferredResult 延期结果
				提供了异步的请求进程
	useDefaultResponseMessages(使用默认的响应信息)
			true:默认的信息信息将会加到全局的响应信息中
			false:默认的响应信息不会加到全局的响应信息中
	forCodeGeneration(自动生成代码)
	pathMapping(路径匹配)
		如果默认为基础的api基本路径
	
	select () 启动api选择构建者  (将创建一个新的构建者)
		paths
			PathSelectors
					regex 通过正则表达式匹配url路径
	apiInfo()将api描述信息录入
private ApiInfo testApiInfo(){
		Contact contact=new Contact();
		contact.setName("赵睿");
		ApiInfo apiInfo=new ApiInfo("标题", "描述", "v0.0.1", "服务条款链接", contact.getName(), "许可证", "许可证链接");
		return apiInfo;
	}

    /**
     * 简单接口描述
     *
     * @param userName
     * @return
     */
    @RequestMapping(value = "/demo1", method = RequestMethod.POST)
    @ApiOperation(value = "测试接口1", notes = "简单接口描述 userName必填", code = 200, produces = "application/json")
    public ModelMap getDemo(@RequestParam("userName") String userName) {
        ModelMap map = new ModelMap();
        map.addAttribute("userName", userName);
        return map;
    }

© 著作权归作者所有

洞渊龙王

洞渊龙王

粉丝 1
博文 47
码字总数 20916
作品 0
海淀
程序员
私信 提问
ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发...

依乐祝
2018/06/28
0
0
swagger入门和实践(含docker部署swagger)

简介 Swagger 是最流行的 API 开发工具,它遵循 OpenAPI Specification(OpenAPI 规范,也简称 OAS)。 Swagger 可以贯穿于整个 API 生态,如 API 的设计、编写 API 文档、测试和部署。 Swag...

数据架构师
2018/09/23
0
0
巧用 Swagger 在线编辑器生成前端接口代码

Swagger 简要介绍 Swagger / Open API 在Restful API 领域已慢慢成为标准,越来越多的系统使用swagger来规范开发接口文档,由于Swagger 本身并不依赖特定的语言和开发平台,所以特别合适作为...

vellengs
2018/07/02
0
0
使用swagger 生成 Flask RESTful API

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

goodspeed
2017/07/11
0
0
WebApi中使用swagger ui自动生成接口文档

之前就写到。最近正在使用webapi。这里介绍一个实用的东西swageer ui 现在开发都是前后端分开。我们这里是给前端提供api。有时候对于一个api的描述,并不想专门写一份文档。很浪费时间。 sw...

Jokeny
2018/09/21
1K
0

没有更多内容

加载失败,请刷新页面

加载更多

mysql-connector-java升级到8.0后保存时间到数据库出现了时差

在一个新项目中用到了新版的mysql jdbc 驱动 <dependency>     <groupId>mysql</groupId>     <artifactId>mysql-connector-java</artifactId>     <version>8.0.18</version> ......

ValSong
今天
5
0
Spring Boot 如何部署到 Linux 中的服务

打包完成后的 Spring Boot 程序如何部署到 Linux 上的服务? 你可以参考官方的有关部署 Spring Boot 为 Linux 服务的文档。 文档链接如下: https://docs.ossez.com/spring-boot-docs/docs/r...

honeymoose
今天
6
0
Spring Boot 2 实战:使用 Spring Boot Admin 监控你的应用

1. 前言 生产上对 Web 应用 的监控是十分必要的。我们可以近乎实时来对应用的健康、性能等其他指标进行监控来及时应对一些突发情况。避免一些故障的发生。对于 Spring Boot 应用来说我们可以...

码农小胖哥
今天
8
0
ZetCode 教程翻译计划正式启动 | ApacheCN

原文:ZetCode 协议:CC BY-NC-SA 4.0 欢迎任何人参与和完善:一个人可以走的很快,但是一群人却可以走的更远。 ApacheCN 学习资源 贡献指南 本项目需要校对,欢迎大家提交 Pull Request。 ...

ApacheCN_飞龙
今天
5
0
CSS定位

CSS定位 relative相对定位 absolute绝对定位 fixed和sticky及zIndex relative相对定位 position特性:css position属性用于指定一个元素在文档中的定位方式。top、right、bottom、left属性则...

studywin
今天
8
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部