swagger

/**
 * @program: SpringBoot-study
 * @description:
 * @author: 步尔斯特
 * @create: 2021-05-29 16:19
 **/
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(RequestHandlerSelectors.basePackage("com.uncle.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }
    /*
     * @Description: 自定义文档的介绍
     * @Param: []
     * @return: springfox.documentation.service.ApiInfo
     * @Author: 步尔斯特
     * @Date: 2021/5/29
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot-study-05-swagger")
                .description("这是学习swagger的模块")
                .build();
    }
}

@RestController
@RequestMapping("/guest")
@Api(tags = "嘉宾相关的接口",description = "对嘉宾进行增删改查的接口")
public class GuestController {


//    @RequestMapping(method = RequestMethod.GET)
    @GetMapping
    @ApiOperation("查询嘉宾列表")
    public String list(Model model) {
        return "list";
    }
    @ApiIgnore
    @GetMapping("/toAdd")
    public String toAdd() {
        return "add";
    }

    @PostMapping
    @ApiOperation("添加嘉宾列表")
    public String add(Guest guest) {

        return "add guest";
    }
    @ApiIgnore
    @GetMapping("/toUpdate/{name}")
    public String toUpdate(@PathVariable("name") String name) {

        return "update";
    }

    @PutMapping
    @ApiOperation("更新询嘉宾列表")
    public String update(Guest guest) {
        return "update guest";
    }

    @DeleteMapping("{name}")
    @ApiOperation("删除询嘉宾列表")
    @ApiImplicitParam(name = "name",value = "姓名")
    public String delete(@PathVariable("name") String name) {
        return "delete guest";
    }
}

/**
 * @program: SpringBoot-study
 * @description: 嘉宾实体类
 * @author: 步尔斯特
 * @create: 2021-03-03 14:20
 **/

@Data@AllArgsConstructor@NoArgsConstructor
@ApiModel("嘉宾")
public class Guest {
    @ApiModelProperty("名字")
    private String name;
    @ApiModelProperty("角色")
    private String role;
}