前后端分离-利用Swagger生成接口文档

最新推荐文章于 2024-03-24 11:39:50 发布

a1396537376

最新推荐文章于 2024-03-24 11:39:50 发布

阅读量2.1k

点赞数

分类专栏：前后端分离文章标签： Swagger 接口文档

本文链接：https://blog.csdn.net/a1396537376/article/details/100133575

版权

本文介绍了如何利用Swagger来生成接口文档，详细讲解了Swagger的配置步骤，包括在pom.xml中添加依赖，配置Swagger及WebMvc。通过编写简单的接口，并访问http://localhost:8080/swagger-ui.html#/查看生成的接口文档效果。源码可在文章末尾获取。

摘要由CSDN通过智能技术生成

配置过程

源码见文章尾

pom.xml

<!--swagger-api依赖开始-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.8</version>
        </dependency>
        <!--swagger-api结束-->

配置Swagger

@Component
@EnableSwagger2
@EnableWebMvc  //必须存在
//必须存在，扫描的API Controller包
@ComponentScan(basePackages = {
   "com.swagger.controller"})
public class SwaggerConfig {
   
    @Bean
    public Docket customDocket(){
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());}

    private ApiInfo apiInfo(){
   
        Contact contact = new Contact("GodF","https://www.baidu.com","1234567@qq.com")