Swagger接口文档开发示例

Swagger接口文档开发示例

2023年10月28日发(作者：入团申请书500字(精选23篇))

秋天的童话张杰现场版-

Swagger接⼝⽂档开发⽰例Maven依赖根据代码⽣成⽂档（必须）swagger2 fox springfox-swagger2 2.9.2 r swagger-models

//默认1.5.20版本，会出现类型转换异常问题，排除该版本，引⼊1.5.22版本 r swagger-models 1.5.22 图形界⾯选择（⼆选其⼀）springfox-swagger-ui fox springfox-swagger-ui 2.9.2 （⼆选其⼀）swagger-bootstrap-ui in swagger-bootstrap-ui 1.9.5 接⼝⽂档页⾯的访问⽅式springfox-swagger-ui项⽬ip:端⼝/ ⽰例：localhost:8080/agger-bootstrap-ui项⽬ip:端⼝/ ⽰例：localhost:8080/配置类⽰例@Configuration@EnableSwagger2public class SwaggerConfig {/** * @Description api⾸页信息 * @Param [] * @return o **/ private ApiInfo apiInfo() { Contact contact = new Contact("作者", "作者⽹上主页", "作者邮箱"); return new ApiInfo("接⼝title", //主要 "这是⼀个测试描述", //主要 "版本", "服务链接", contact, "许可", "许可链接", new ArrayList<>() ); } @Bean public Docket docket() { /* * 全局配置信息（可以不⽤） */ Parameter token = new ParameterBuilder().name("token") .description("⽤户令牌") .parameterType("header") .modelRef(new ModelRef("String")) .build(); List parameters = new ArrayList<>(); (token);

return new Docket(R_2) .globalOperationParameters(parameters) //传⼊全局配置 .apiInfo(apiInfo()) //传⼊api⾸页信息 .select() //进⾏筛选 //通过package筛选， .apis(ckage("ller")) //构建api .build(); }}Controller⽰例@Api(tags = "⽤户管理相关接⼝UserController")@RestController@RequestMapping("/user")public class UserController { @ApiOperation("获取⽤户信息") @ApiImplicitParams( { @ApiImplicitParam(name = "username", value = "⽤户名", dataType = "String", required = true ), @ApiImplicitParam(name = "password", value = "⽤户密码",dataType = "String",required = true) } ) @PutMapping("/updateUser") public String updateUser(String username,String password) { return username+","+password; } @PostMapping("/addUser") public User addUser(@RequestBody User user) { return user; } @GetMapping("/getUser") public String getUser(){ return "gcl"; } @DeleteMapping("/deleteUser") public String deledteUser(){ return "删除"; }实体类⽰例/* @ApiModel 对实体类⽣成⽂档*/@ApiModel/* @Data lombok插件,可以不选，那就需要⼿动⽣成构造⽅法和get，set⽅法*/@Datapublic class User { /* @ApiModelProperty 对属性进⾏配置 */ @ApiModelProperty(value = "⽤户id ",name = "idName",required = true) private int id; @ApiModelProperty(value = "⽤户名称 ",name = "nameName",required = true) private String name; @ApiModelProperty(value = "⽤户年龄 ",name = "ageName",required = true) private int age;}后记忽略通过@ApiIgnore 放在类前或⽅法前，则不扫描该类或⽅法通过RequestHandlerSelectors筛选RequestHandlerSelectors配置筛选规则有五个⽅法any() //所有none() //⽆withMethodAnnotation() //按照⽅法上的注解withClassAnnotation() //按照类上的注解basePackage() //按照包扫描使⽤⽅法.apis(ckage("ller"))通过PathSelectors筛选四个⽅法any() //所有none() //不扫描regex() //正则ant() //ant路径使⽤⽅法.paths(("/user/**"))

有关端午节的作文500字-