SpringBoot使用Swagger2构建API文档

1、Swagger2介绍

  Swagger2这套自动化文档工具来生成文档,它可以轻松的整合到Spring Boot中,并与Spring MVC程序配合组织出强大RESTful API文档。

2、SpringBoot开启Swagger2支持

  1、导入依赖

<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>

  2、设置配置类

package com.offcn.demo.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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    public ApiInfo apiInfo(){
        return new ApiInfoBuilder().title("Spring Boot中使用Swagger2构建RESTful APIs").description("u就业")
                .termsOfServiceUrl("http://www.ujiuye.com/").contact("Sunny").version("0.0.1").build();
    }

    @Bean
    public Docket docket(){
        return  new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.offcn.demo.Controller"))
                .paths(PathSelectors.any()).build();
    }
}

  3、在controller层中的代码添加文档注释

通过@ApiOperation注解来给API增加说明 通过@[email protected]注解来给参数增加说明

@GetMapping("/getMap")
@ApiOperation(value = "获得数据",notes = "获得数据")
@ApiImplicitParam(name = "id" ,value = "用户id",required = true,dataType = "Integer")//required是否是必填属性
public Map getMap(Integer id){
     Map<String,String> map=new HashMap<>();
     map.put("name","xzy");
    return map;}
@RequestMapping("/test/{id}")@ApiOperation(value = "输出汽车的id和name",notes = "输出汽车的id和name")@ApiImplicitParams({        @ApiImplicitParam(name = "id",value = "汽车id",dataType = "Integer",required = true),        @ApiImplicitParam(name = "name",value = "汽车牌子",dataType = "String",required = true)})public Car getCar(@PathVariable("id") Integer id, @RequestParam("name") String name){    Car c = new Car(id, name, 100000, new Date());    return c;}

   4、查看生成的文档

  http://localhost:8080/swagger-ui.html

原文地址:https://www.cnblogs.com/xueziyeya/p/11801508.html

时间: 2024-10-08 13:58:45

SpringBoot使用Swagger2构建API文档的相关文章

Spring Boot中使用Swagger2构建API文档

程序员都很希望别人能写技术文档,自己却很不愿意写文档.因为接口数量繁多,并且充满业务细节,写文档需要花大量的时间去处理格式排版,代码修改后还需要同步修改文档,经常因为项目时间紧等原因导致文档滞后于代码,接口调用方的抱怨声不绝于耳.而程序员是最擅长"偷懒"的职业了,自然会有多种多样的自动生成文档的插件.今天要介绍的就是Swagger. 接下来我们在Spring Boot中使用Swagger2构建API文档 Swagger是一个简单但功能强大的API表达工具.它具有地球上最大的API工具生

springboot利用swagger构建api文档

一.引入jar pom.xml <!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.spr

java Spring Boot中使用Swagger2构建API文档

1.添加Swagger2的依赖 在pom.xml中加入Swagger2的依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.spr

SpringBoot+rest接口+swagger2生成API文档+validator+mybatis+aop+国际化

代码地址:JillWen_SpringBootDemo mybatis 1. 添加依赖: <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>${mybatis.version}</version> </dependency> &

白话SpringCloud | 第十一章:路由网关(Zuul):利用swagger2聚合API文档

前言 通过之前的两篇文章,可以简单的搭建一个路由网关了.而我们知道,现在都奉行前后端分离开发,前后端开发的沟通成本就增加了,所以一般上我们都是通过swagger进行api文档生成的.现在由于使用了统一路由网关了,都希望各微服务的api文档统一的聚合在网关服务中,也方便前端用户查阅,不需要每个服务单独查看.当然了,也是可以做一个文档索引网页进行各微服务的api文档链接的.今天,我们就来讲下使用swagger实现自动化聚合微服务文档功能. 注:关于Swagger的介绍和使用,由于在之前的Spring

ShowDoc上手构建api文档

ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却很不希望要写文档.因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非技术细节. word文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档.这种沟通方式当然可以,只是效率不高. ShowDoc就是一个非常适合IT团队

springfox+swagger2生成API文档

1.建立一个spring mvc工程: 2.添加POM依赖: 1 <properties> 2 <springfoxversion>2.6.1</springfoxversion> 3 </properties> 4 <dependencies> 5 <dependency> 6 <groupId>io.springfox</groupId> 7 <artifactId>springfox-swag

SpringBoot整合Swagger2搭建API在线文档

Swagger,中文"拽"的意思,它是一个功能强大的在线API在线文档,目前它的版本为2.x,所以称为Swagger2.Swagger2提供了在线文档的查阅和测试功能.利用Swagger2很容易构建RESTful风格的API,在SpringBoot中集成Swagger2,步骤如下. 1.引入依赖 <!--Swagger2--> <dependency> <groupId>io.springfox</groupId> <artifac

Spring Boot2 系列教程 (四) | 集成 Swagger2 构建强大的 RESTful API 文档

前言 快过年了,不知道你们啥时候放年假,忙不忙.反正我是挺闲的,所以有时间写 blog.今天给你们带来 SpringBoot 集成 Swagger2 的教程. 什么是 Swagger2 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务. 为什么使用 Swagger2 ? 相信刚开始不熟悉 web 开发的时候,大家都有手写 Api 文档的时候.而手写 Api 文档主要有以下几个痛点: 文档需要更新的时候,需要再次发送一份给前端,也就是文档更