swagger

jiuanc

于 2021-05-23 20:55:56 发布

阅读量69

点赞数

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

本文链接：https://blog.csdn.net/jiuanc/article/details/117200497

版权

java 专栏收录该内容

18 篇文章 0 订阅

订阅专栏

swagger

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

写入配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))    //这两个是说，其中有"/admin/.*"不显示
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }

    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()       //以下皆可改
                .title("网站-课程中心API文档")     
                .description("本文档描述了课程中心微服务接口定义”）
                .version("1.0")
                .contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com"))
                .build();

    }

}

访问swagger（固定的）：http://localhost:8001/swagger-ui.html

注：在EduTeacherController中，加入一些注解，使swagger有中文提示

定义在类上：@Api

定义在方法上：@ApiOperation

定义在参数上：@ApiParam

例：

@Api(description = "讲师管理")   //给swagger添加一些中文注释
@RestController      //交给spring，返回json数据
@RequestMapping("/eduservice/edu-teacher")  //访问的注解

public class EduTeacherController {

    //把service注入
    @Autowired
    private EduTeacherService teacherService;

    //查询：http://localhost:8001/eduservice/edu-teacher/findAll

    //查询讲师列表所用数据
    //rest风格
    @ApiOperation(value = "所有讲师列表")   //给swagger添加一些中文注释
    @GetMapping("findAll")
    public List<EduTeacher> findAllTeacher(){
        //调用service的方法实现查询所有的操作
        List<EduTeacher> list=teacherService.list(null);
        return list;
    }


    @ApiOperation(value = "逻辑删除讲师")   //给swagger添加一些中文注释
    @DeleteMapping("{id}")   //id值，需要通过路径传递，例：localhost:8001/edu/delete/1(id=1)
    public boolean removeById(@ApiParam(name = "id",value = "讲师id",required = true) @PathVariable String id){
        return teacherService.removeById(id);
    }

}