【技术实现步骤摘要】
本专利技术涉及接口优化以及文档管理，特别是一种restful api文档生成和调试软件系统、开发优化方法。
技术介绍
1、在目前前后端技术分离的大背景下，前后端开发过程中，后端为前端提供接口的同时，还需要提供接口的说明文档。后端研发人员可能需要不断的维护并通知前端开发以及测试人员最新状态，整个过程一直都需要研发人员自己主动去沟通，有时通知不及时，就会影响前端开发以及测试人员的工作进度，或者造成一些不必要的问题；同时后端研发人员可能需要反复的去定位和查找自己写的接口及接口注释等内容，无形中也会浪费大量本可以用于其他开发内容的时间，导致整体工作效率较低。
技术实现思路
1、鉴于此，本专利技术提供一种restful api文档生成和调试软件系统、开发优化方法。
2、本专利技术公开了一种restful api文档生成和调试软件系统，其包括：
3、api接口定义模块，用于定义restful api接口；
4、数据类型定义模块，用于定义请求参数和响应参数的数据类型；
5、请求参数定义模块，用于描述请求参数的相关信息；相关信息包括类型、名称、默认值和是否必需；
6、响应参数定义模块，用于描述响应参数的相关信息；
7、错误码定义模块，用于定义api接口可能返回的错误码；
8、文档生成器模块，用于生成api接口的文档。
9、进一步地，所述api接口定义模块、所述数据类型定义模块、所述请求参数定义模块和所述
10、本专利技术还公开了一种基于接口约定的开发优化方法，采用上述任一项所述的restful api文档生成和调试软件系统，其包括：
11、步骤1：配置pom文件，在pom.xml文件中引入swagger的相关依赖；
12、步骤2：编写swagger配置文件swaggerconfig，指定生成api的包名以及路径，在接口层加入swagger的相关内容进行文字描述，以便于用户理解调用的接口；其中，配置文件swaggerconfi包括整个展示在页面上的api的描述信息；相关内容包括注解对接口以及参数。
13、进一步地，在所述步骤1中：
14、若暂时只使用swagger的web接口管理以及接口测试的功能，可只引入springfox-swagger-ui和springfox-swagger2的依赖即可。
15、进一步地，所述swagger使用的注解及其说明为：
16、@api：用在类上，说明该类的作用；@apioperation：注解来给api增加方法说明；@apiparam：定义在参数上；@apiresponses：用于表示一组响应；@apiresponse：用在@apiresponses中，用于表达一个错误的响应信息；code：数字；message：信息；response：抛出异常的类；@apimodel：描述一个model的信息；@apimodelproperty：描述一个model的属性；@apiimplicitparams：用在方法上包含一组参数说明；@apiimplicitparam：用于注解以给方法入参增加说明。
17、进一步地，所述@apiimplicitparam的参数包括：
18、paramtype：指定参数的位置；header：请求参数放置于request header；使用@requestheader获取query：请求参数放置于请求地址；使用@requestparam获取path：用于restful接口->请求参数的获取；@pathvariable body：不常用，form：不常用；name：参数名；datatype：参数类型；required：参数是否必须传true|false；value：说明参数的意思；defaultvalue：参数的默认值。
19、进一步地，所述步骤2之后，还包括：
20、运行项目后，访问swagger配置类中配置的url页面，多个项目可使用同一个swagger接口管理地址，只需要在进入接口管理页面后切换到对应的api文档即可；页面可显示在代码中编写的接口管理描述信息，可直接对接口进行调用测试，也可查看到接口所需参数，请求地址，接口说明信息以及实体类信息。
21、进一步地，conntroller中定义的方法必须在有@requestmapper参数的方法中显示的指定requestmethod类型；否则，sawggerui默认为全类型皆可访问，api列表中生成多条项目。
22、进一步地，所述步骤2之后，还包括：
23、若在springboot项目中集成springsecurity，则接口被拦截，在springsecurity的配置类中重写configure方法，对swagger页面地址进行过滤配置。
24、由于采用了上述技术方案，本专利技术具有如下的优点：提高了整体开发效率，简化了前后端接口对接复杂程度，规范了接口，便于后期维护，方便进行功能测试等。
本文档来自技高网...【技术保护点】
1.一种RESTful API文档生成和调试软件系统，其特征在于，包括：
2.根据权利要求1所述的RESTful API文档生成和调试软件系统，其特征在于，所述API接口定义模块、所述数据类型定义模块、所述请求参数定义模块和所述响应参数定义模块均可采用开放标准格式。
3.一种基于接口约定的开发优化方法，采用权利要求1或2所述的RESTful API文档生成和调试软件系统，其特征在于，包括：
4.根据权利要求3所述的基于接口约定的开发优化方法，其特征在于，在所述步骤1中：
5.根据权利要求3所述的基于接口约定的开发优化方法，其特征在于，所述Swagger使用的注解及其说明为：
6.根据权利要求3所述的基于接口约定的开发优化方法，其特征在于，所述@ApiImplicitParam的参数包括：
7.根据权利要求3所述的基于接口约定的开发优化方法，其特征在于，所述步骤2之后，还包括：
8.根据权利要求7所述的基于接口约定的开发优化方法，其特征在于，Conntroller中定义的方法必须在有@Request
9.根据权利要求3所述的基于接口约定的开发优化方法，其特征在于，所述步骤2之后，还包括：
...【技术特征摘要】
1.一种restful api文档生成和调试软件系统，其特征在于，包括：
2.根据权利要求1所述的restful api文档生成和调试软件系统，其特征在于，所述api接口定义模块、所述数据类型定义模块、所述请求参数定义模块和所述响应参数定义模块均可采用开放标准格式。
3.一种基于接口约定的开发优化方法，采用权利要求1或2所述的restful api文档生成和调试软件系统，其特征在于，包括：
4.根据权利要求3所述的基于接口约定的开发优化方法，其特征在于，在所述步骤1中：
5.根据权利要求3所述的基于接口约定的开发优化方法，其特征在于，所述swagger使用的注解及...
【专利技术属性】
技术研发人员：李欣，李元正，李乾洲，
申请(专利权)人：北京国泰网信科技有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。