springboot 使用swagger自动生成API文档

栏目: Java · 发布时间: 4个月前

来源: www.lijinpeng.top

本文转载自:https://www.lijinpeng.top/2019/05/20/springbootUseSwagger/,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有。

如今微服务是趋势,微服务下的web开发通常采用前后端分离的方式.前后端通过API进行交互,Swagger ui,可以生成能让前端开发人员预览且测试的API文档

在SpringBoot中集成swagger,方法如下

  1. 将下面的依赖添加到Maven项目的pom.xml文件中。springfox-swagger2组件帮助我们自动生成描述API的 json 文件,而springfox-swagger-ui组件就是将这个json文件解析出来,用一种更友好的方式呈现出来。
<!-- swagger 相关依赖  -->
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.6.1</version>
 </dependency>
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.6.1</version>
 </dependency>
  1. 添加Swaager2的配置类

    package com.jetlee.demo1_server.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    
    
    @Configuration
    public class Swagger2 {
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.jetlee.demo1_server"))
                    .paths(PathSelectors.any())
                    .build();
        }
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("springboot利用swagger构建api文档")
                    .description("简单优雅的restfun风格")
                    .termsOfServiceUrl("https://www.lijinpeng.top")
                    .version("1.0")
                    .build();
        }
    }
    
  2. 在Applocation入口中使用Swagger2 @EnableSwagger2

package com.jetlee.demo1_server;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class Demo1ServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(Demo1ServerApplication.class, args);
    }
}
  1. 在Controller类上添加@API注解,方法想添加@ApiOperation,以及@ApiImplicitParam参数信息
    package com.jetlee.demo1_server.controller;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    
    @RestController
    @Api("测试 swagger2")
    public class IndexController {
    
        @ApiOperation(value = "获取用户列表",notes = "获取用户列表")
        @GetMapping("/getUserList")
        public String getUserList(){
            return  "ok";
        }
        
        @ApiOperation(value = "按id查找用户",notes = "按id查找用户")
        @ApiImplicitParam(name="userId",value="用户id",paramType="query",required = true,dataType = "int")
        @GetMapping("/getUserById")
        public String getUserById(){
            return  "user";
        }
    }
    

这样就可以生成api文档,在浏览器输入 http://127.0.0.1:9091/swagger-ui.html 显示结果如下

springboot 使用swagger自动生成API文档

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网

关注码农网公众号

关注我们,获取更多IT资讯^_^


为你推荐:

相关软件推荐:

查看所有标签

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

使用HTML5和Node构建超媒体API

使用HTML5和Node构建超媒体API

【美】Mike Amundsen(麦克.阿蒙森) / 臧秀涛 / 电子工业出版社 / 2014-5 / 55.00元

《使用HTML5和Node构建超媒体API》探讨了超媒体API 的设计,介绍了作为超媒体API 的构件块的超媒体因子,并讲解了基本格式、状态转移、领域风格和应用流程这4 种超媒体设计元素;之后作者结合具体的场景,通过3个动手实验章节,从超媒体因子和超媒体设计元素入手,用实际的代码向我们详细地演示了超媒体API 的设计;最后介绍了超媒体设计的文档编写、注册与发布等内容。 《使用HTML5和No......一起来看看 《使用HTML5和Node构建超媒体API》 这本书的介绍吧!

UNIX 时间戳转换
UNIX 时间戳转换

UNIX 时间戳转换

HEX CMYK 转换工具
HEX CMYK 转换工具

HEX CMYK 互转工具

HEX HSV 转换工具
HEX HSV 转换工具

HEX HSV 互换工具