前端与后端开发过程中总有先后过程。前后端联调的时候,也许后端开发人员以及忘记原先开发的代码接口情况。没有前端界面的支持对后端来说测试开发代码的功能也很费劲。
为方便提供接口给前端,也为了后端人员方便测试。我们可以使用jsondoc。
以下是springBoot框架下的环境搭建。
在search for dependencies框写入web
然后点击Generate Project按钮 下载demo
2.在pom.xml文件里配置
按如下配置:
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
<spring.version>4.2.4.RELEASE</spring.version>
<spring-boot.version>1.3.2.RELEASE</spring-boot.version>
<platform-bom.version>2.0.2.RELEASE</platform-bom.version>
<jsondoc.version>1.2.11</jsondoc.version>
</properties>
加入jar:
(1)、加入 spring-boot-starter-jsondoc.jar
<dependency>
<groupId>org.jsondoc</groupId>
<artifactId>spring-boot-starter-jsondoc</artifactId>
<version>1.2.11</version>
</dependency>
(2)、加入jsondoc-ui-webjar.jar
<dependency>
<groupId>org.jsondoc</groupId>
<artifactId>jsondoc-ui-webjar</artifactId>
<version>1.2.11</version>
</dependency>
(3)、加入 spring-boot-starter-web
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
(4)、加入spring-boot-starter-test.jar
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
(5)、加入platform-bom.jar
<dependency>
<groupId>io.spring.platform</groupId>
<artifactId>platform-bom</artifactId>
<version>${platform-bom.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
加入maven-compiler-plugin插件:
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.3</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
--------------------------------
因为我们公司的项目已经引入相关包文件、我在pom文件只要加2个jar
(1)、加入 spring-boot-starter-jsondoc.jar
<dependency>
<groupId>org.jsondoc</groupId>
<artifactId>spring-boot-starter-jsondoc</artifactId>
<version>1.2.11</version>
</dependency>
(2)、加入jsondoc-ui-webjar.jar
<dependency>
<groupId>org.jsondoc</groupId>
<artifactId>jsondoc-ui-webjar</artifactId>
<version>1.2.11</version>
</dependency>
----------------------------------
3.在resource包下,application.properties配置如下:
# mandatory configuration
jsondoc.version=1.0 //jsondoc的版本
jsondoc.basePath=http://localhost:8080 //路径是本机,端口8080
jsondoc.packages[0]=org.mvnsearch.jsondoc.controller // 扫描路径下的包
# optional configuration
jsondoc.playgroundEnabled=true
jsondoc.displayMethodAs=URI
所遇问题:jsondoc.packages[0]必须为数组,否则api下无内容
至此我们的jsondoc环境已经准备完毕,接下来我们在controller中添加注解
4.在controller加入注解如下:
class的注解
@RestController //rest风格
@RequestMapping(value = “/user") //映射路径
@Api(description = "会员服务", name = "UserService", group =“ 范围内容”)
@ApiAuthToken(testtokens = “user") //设置testtokens的值,testtokens的值可以写死
方法注解
@RequestMapping(“/{id}”) //映射路径
@ApiMethod(id = "Find_user_one", description = "根据会员ID查找会员", summary = "Gets a book given the book ID”) //Api方法
@@ApiAuthNone
public User show(@ApiQueryParam(name = "id", description = "主键id", format = "Integer") @RequestParam Integer id) //获取路径下的id、user id、type
5.所遇到问题:显示不出jsondoc-ui.html的页面
原因:项目中的拦截器拦截了,可以通过builder.addExcludedPath("/jsondoc-ui.html");
builder.addExcludedPath("/webjars/**");来解决
6.删掉document文件夹就不会显示Overview,删除authentication.html、domain-diagram.html 、http-response-codes.html、http-verbs.html、ubiquitous-language.html不会显示Overview下面的链接
相关推荐
JSONDOC是JSON的辅助工具包,可以处理对象影射
使用Spring Boot,Hibernate ORM,H2 inMemory数据存储开发的示例服务来演示微服务架构。 添加了HATEOAS功能。 添加了对使用Jsondoc api的用户交互式文档的支持。 #技术堆栈。 (超媒体是应用程序状态的引擎)。...
maven-jsondoc-插件 maven-jsondoc-插件 <groupId>org.jsondoc <artifactId>maven-jsondoc-plugin <version>1.0.2-SNAPSHOT ${project.version} <apiBasePath>/rest/api/v1 <packageToScan>org.exmaple...
在Python开发中,PyPI是全球最大的Python软件仓库,开发者可以在这里发布自己的Python模块,供其他人下载使用。ua2.jsondoc可能是一个处理JSON文档或者与用户代理相关的Python库。 描述中提到"资源来自pypi官网",...
Anteros-JSONDoc-UI-Webjar
在Web开发中,User-Agent是HTTP头中的一个字段,它包含了客户端(通常是浏览器)的信息,如浏览器类型、版本、操作系统等。ua2可能提供了解析、识别、甚至模拟User-Agent字符串的功能,这对于开发者进行网页适配、...
JSONDoc 官方网站: : 想要贡献? 请遵循以下几条准则: 在Github上公开的问题,以便我们进行讨论 在讨论并同意问题后,请从master分支开始分支代码,分支名称等于“ ISSUE-X”,其中X是Github上的问题编号 不要...
### Qt调用GET/POST接口详解 在现代软件开发中,客户端与服务器之间的通信变得尤为重要。其中,HTTP请求是实现这种交互的一种常见方式。本文将详细介绍如何使用Qt库中的`QNetworkAccessManager`类来发起GET和POST...
Python + Selenium + AllureReport 用JsonDoc来实现数据驱动。 侧重点在 制作出定高度制化的AllureReport
思维游戏/jsondoc 简单的、基于文件的对象/文档数据库,使用 JSON 文件进行持久化。概述对象图被序列化并作为 JSON 文档存储在单个文件中 - JSON 表示(可选,默认情况下)以人类可读和 CVS 友好的方式缩进和格式化...
在Qt中使用ZeroMQ通常需要借助qtzmq库,这是一个将ZeroMQ接口封装为Qt对象的第三方库。要添加qtzmq库,你需要先下载并安装ZeroMQ和libczmq,然后获取qtzmq源码并将其编译为适用于你的Qt版本的库。在Qt Creator中,将...
QT框架是C++的跨平台应用开发库,它提供了丰富的功能,包括GUI、网络编程、多线程等。QT5版本对JSON支持有了很大的提升,使得在QT中处理JSON数据变得更加便捷。本教程主要围绕QT5如何将数据转化为JSON格式,这对于...
在IT行业中,C++和Qt5是两种非常重要的技术,特别是在开发桌面应用程序时。Qt5是一个跨平台的应用程序开发框架,它提供了丰富的库和工具,让开发者能够方便地创建功能强大的用户界面。在这个场景中,我们关注的是...
QT5是Qt开发框架的一个版本,它提供了丰富的功能和库,包括对JSON(JavaScript Object Notation)文件的解析。JSON是一种轻量级的数据交换格式,因其简洁和易于阅读的特性,广泛应用于网络服务和应用程序之间的数据...
输出样本: doc1.document.jsondoc1.page.005.jsondoc1.page.005.pngdoc1.page.005.table.00.csvdoc1.page.005.table.00.jsondoc2.document.jsondoc3.document.jsondoc3.page.004.jsondoc3.page.004.pngdoc3.page....
在Lotus Domino环境中,通过LotusScript可以方便地处理JSON数据,提升开发效率。 【描述】"在LotusScript中使用JSON,比较方便" 这句话强调了在LotusScript中操作JSON的便捷性。LotusScript是IBM Lotus Domino...
概述 ... 模块化设计。 简单的验证界面。 ... 您可以轻松地用另一种替换它。 具有自定义约束条件,可轻松扩展。... 没有对超媒体验证/语义验证规范附录的明确支持。...git clone ......use JsonDoc \ JsonDoc
QJsonDocument jsondoc = QJsonDocument::fromJson(data,&parseError;); if(jsondoc.isNull() || parseError.error != QJsonParseError::NoError){ qDebug() (); return; } QJsonObject jsonObject = jsondoc....
如果检测到JSON文档(例如,使用http://jsondoc.eu01.aws.af.cm/api/jsondoc),则会在浏览器中自动激活编辑器。 功能:*具有语法突出显示,搜索,替换和自动完成功能HTML / CSS / JavaScript编辑器*实时代码预览*从...