学-记-swagger的简单使用

最新推荐文章于 2024-09-16 20:08:29 发布

weixin_48873206

最新推荐文章于 2024-09-16 20:08:29 发布

阅读量66

点赞数

分类专栏：学习文章标签： java

本文链接：https://blog.csdn.net/weixin_48873206/article/details/117261615

版权

学习专栏收录该内容

8 篇文章 0 订阅

订阅专栏

Swagger的简单使用

第一步：导入依赖

<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.9.2</version>
</dependency>
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.9.2</version>
</dependency>

第二步：书写配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket getDocket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        docket.apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zhy.fmall.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("fmall接口文档")
                .description("")
                .termsOfServiceUrl("http://localhost:3306")
                .contact(new Contact("小蜜蜂","www.fmall.com","fmall@163.com"))
                .version("1.0")
                .build();
    }
}

第三步：书写相关注解

@RestController
@Api(value = "详细说明：提供用户相关接口",tags = "标题说明：用户管理")
public class UserController {
    @Autowired
    private UserService userService;

    @ApiOperation("描述接口的作用：")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "",name = "username",value = "参数说明：用户名",required = false)
    })
    @RequestMapping(value = "/user",method = RequestMethod.POST)
    public String demo(@RequestParam("username") String name){
        List<User> all = userService.getAll();
        return all.toString();
    }
}

@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
@ApiModel(value = "实体类描述：User用户对象",description = "用户对象，查询数据库")
public class User {
    @ApiModelProperty(value = "属性描述：用户id",dataType = "数据类型:int")
    private Integer id;
    @ApiModelProperty(value = "属性描述：用户名",dataType = "数据类型：String")
    private String username;
    @ApiModelProperty(value = "属性描述：用户密码",dataType = "数据类型：String")
    private String password;
}