首页天道酬勤,

,

张世龙 05-05 21:29 31次浏览

java的swagger使用接口api

java的swagger使用接口api

swagger配置概述

我们的项目时ssm框架。 我在我们的网络项目上进行了测试:

1 .参照POM

com.fasterxml .热草丛. core

热草丛-databind

2.9.5

io.springfox

springfox-swagger2

2.6.1

io.springfox

springfox-swagger-ui

2.6.1

经过测试,2.9.2中的swagger、spring 4.0.6不可用,需要升级(spring4.3.17可用)。

2 .构成若干公共信息。 需要新的班级。 这里是ApiConfig.java . (这个可以不构成。 swagger有默认值,但最好设置接口的公共信息。 )

importorg.spring帧work.context.annotation.bean;

importorg.spring帧. context.annotation.components can;

importorg.spring framework.context.annotation.configuration;

importorg.spring framework.stereotype.com ponent;

importorg.spring framework.web.servlet.config.annotation.enablewebmvc;

importorg.spring framework.web.servlet.config.annotation.webmvcconfigurationsupport;

importspringfox.documentation.builders.apiinfobuilder;

importspringfox.documentation.builders.parameter builder;

importspringfox.documentation.builders.path selectors;

importspringfox.documentation.builders.requesthandlerselectors;

importspringfox.documentation.schema.model ref;

importspringfox.documentation.service.API info;

importspringfox.documentation.service.parameter;

importspringfox.documentation.SPI.documentation type;

importspringfox.documentation.spring.web.plugins.docket;

importspringfox.documentation.swagger2. annotations.enable swagger 2;

import java.util.ArrayList;

import java.util.List;

//*

* @author xyd

* @使用描述swagger

* @date 2019/06/08 11:09

*/

@Configuration

@EnableSwagger2

@ components can (base packages={ ' com.bee.daifu.web ' }

@EnableWebMvc

publicclassapiconfigextendswebmvcconfigurationsupport {

@Bean

公共文档自定义文档(

//*

*设置全局参数(非必需) ) ) ) )。

*/

parameterbuilderticketpar=newparameterbuilder (;

List pars=new ArrayList (;

ticketpar.name(token ).description (令牌).model ref (new model ref (string ) ).parametertype () ) header ) )。

. required(false ).build ); //header的token参数不是必需的,可以传递空值

PARS.add(ticketpar.build ) ); //根据各方法的名称,也可以知道当前方法设定了哪个参数

//*

*这里包含正则表达式

*/

返回新文档(文档类型. swagger _2).select )。

APIs (requesthandlerselectors.base package (' com.bee.daifu ' ) )

. paths(pathselectors.any ) )

. build () )

//globaloperationparameters (pars ) .加载全局参数(如果有)

. APIinfo(APIinfo );

}

//*

*这是大标题小标题的设定

* @return

*/

ApiInfo apiInfo (

返回新应用程序().title(Swagger测试项目) )。

. description(Java后端接口api文档) )

. version('0.1.0) ) ) )。

//termsofserviceurl (http://192.168.1.2433608888/swagger-ui.html ) )

. build (;

}

}

3 .配置静态访问: sprint servlet配置如下:

4 .开始写界面。 这里以测试控制器为例:

import com.bee.sys.utils.Result;

import io.swagger.annotations.*;

importorg.spring framework.stereotype.controller;

importorg.spring帧web.bind.annotation.request mapping;

importorg.spring帧web.bind.annotation.response body;

importorg.spring帧web.bind.annotation.rest controller;

//*

* @author xyd

* @描述符测试

* @date 2019/06/08 11:01

*/

@API(tags='这是类的功能说明') )

@RestController//这将参赛自动转换为json

@ request mapping ((' test controller.controller ' ) ) ) ) ) ) )。

公共类测试控制器{

@ API操作(http method=' post ',value='方法的功能说明',response=TestDto.class ) )。

@apiimplicitparams(//准入说明

@apiimplicitparam(name='openId ',value='系统openid ',required=true,dataType='String ' ),

@apiimplicitparam(name='name ',value='用户名',要求=true,dataType='String ' ),

@ apiimplicitparam (名称=' age ',value='用户年龄',required=true,dataType='Integer ' )

() )

@ API响应(value={//我们系统的参与状态为1成功、0失败

@ API响应(代码=1,消息='回调成功')、

@ API响应(代码=0,消息='接口调用失败') ) )。

() )

@requestmapping('test/test ' ) )。

@响应主体

publicresulttest (字符串名称,字符串操作id,Integer age ) {

system.out.println ('=========================)

Result res=new Result (;

res.setresultcode('1);

返回RES;

}

}

5 .查看效果(注意:在此页面上,您可以通过测试接口的连接性、输入参数或单击try it out来看到接口返回)

分享一个转载的东西。 (是工作中自己用的,有问题我就删掉) )。

Swagger2的正确玩法: https://MP.weixin.QQ.com/s/yun SVE 9ku gr5py6hs2 EFA

java的swagger使用界面api相关教程

,