SpringBoot结合Swagger2自动生成api文档的方法

2024-10-27 09:13:48

首先在pom.xml中添加如下依赖,其它web,lombok等依赖自行添加

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

SwaggerConfig.java是swagger2的配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("cn.niit.controller"))
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Spring Boot中使用Swagger2")
        .description("首次尝试自动生成api文档为后期的前后端分离开发做准备")
        .termsOfServiceUrl("https://www.jianshu.com/u/2f60beddf923")
        .contact("WEN")
        .version("1.0")
        .build();
  }
}

实体类User.java

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
  public User(String userName, String password) {
    this.userName = userName;
    this.password = password;
  }

  private Integer id;
  private String userName;
  private String password;
}

新建一个控制类UserController.java，类下有个方法getAllUser

@RestController
@Api(description = "用户管理")
@RequestMapping(value = "/hello",produces = APPLICATION_JSON_VALUE)
public class UserController {

  List<User>lists=new ArrayList<>();

  @GetMapping(value ="getAllUser" )
  @ApiOperation(value = "用户列表",notes = "查询所有已注册过的用户详细信息")
  public List<User> getAllUser()
  {
  lists.add(new User("wen","999"));
  lists.add(new User(2,"qian","666"));
  return lists;
  }
}

点击localhost:8888/swagger-ui.html(我在application.propertise中的server.port=8888)

在类中再添加一个方法addUser

 @PostMapping(value = "addUser")
  public User addUser(User user)
  {
    return user;
  }

实体类User.java的属性上添加如下注解

@ApiModelProperty(value = "用户ID")
  private Integer id;
  @ApiModelProperty(value = "用户名")
  private String userName;
  @ApiModelProperty(value = "密码")
  private String password;

创建用户时有些字段我们并不需要，可以加入如下注解

@ApiModelProperty(hidden = true)

在类中再添加一个根据用户id查询用户的方法

  @GetMapping(value = "getUserById/{id}")
  public User getUserById(@ApiParam(value = "用户ID")@PathVariable(value = "id")String id)
  {
    return new User(id,"步惊云","passwordjava");
  }

汉化成中文文档

在swagger相关的jar包

把META-INF这个包复制到你当前项目的resources目录下

这些是关键，剩下多余的包可自行删除

在swagger-ui.html的<head>部分添加如下代码

<!--国际化操作：选择中文版 -->
 <script src='webjars/springfox-swagger-ui/lang/translator.js' type='text/javascript'></script>
 <script src='webjars/springfox-swagger-ui/lang/zh-cn.js' type='text/javascript'></script>

汉化完成，我们也可以在zh_cn.js中自定义中文名称

另一种生成文档的方式请参见

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

SpringBoot＋Swagger-ui自动生成API文档

随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染.先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远. 这样后段开发好了api 之后就要提交api 文档给前端的朋友.给前端的api 文档各个公司有各个公司的要求,有的是word 有的是 md 文档,或者是 postman 的一个连接. 好了废话不多说说一下 swagger -ui 吧什么是Swagger Swagger是一个Restful风格接口的文档在线自动生成和测试的框架官网:http://swag
SpringBoot结合Swagger2自动生成api文档的方法

首先在pom.xml中添加如下依赖,其它web,lombok等依赖自行添加 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.spri
SpringBoot如何自动生成API文档详解

前言在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写,高级一点的就采用API管理平台手工录入,一个项目有上千上万个接口,天啊,这是多么大的工作量,在接口维护的时候更加痛苦,为了解决这样的事我们可以借助 japi这个项目来完成RESTFul文档的自动生成,完全基于注释生成,更多详细配置可查看https://github.com/dounine/japi. 使用说明克隆项目下来 git c
SpringBoot集成Swagger2构建在线API文档的代码详解

第一部分:代码集成 pom.xml  <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>i
eclipse中自动生成javadoc文档的方法

本文实例讲述了eclipse中自动生成javadoc文档的方法.分享给大家供大家参考.具体方法如下: 使用eclipse生成文档(javadoc)主要有三种方法: 1. 在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在Javadoc Generation对话框中有两个地方要注意的: javadoc command:应该选择jdk的bin/javadoc.exe destination:为生成文档的保存路径,可自由选
PhpDocumentor 2安装以及生成API文档的方法

官网地址:http://www.phpdoc.org/项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以分析php源代码和注释块并生成文档的程序. 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性. phpDocumentor 2的特点: 兼容php5.3,全面支持命名空间和闭包等. 识别支持任何tag,以及一些追加的 (比如 @li
Django restful framework生成API文档过程详解

自动生成api文档(不管是函数视图还是类视图都能显示) 1.安装rest_framework_swagger库 pip install django-rest-swagger 2.在项目下的 urls.py 中加入如下: from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title='API文档') urlpatterns += [ path(r'docs/', sch
Springboot集成knife4j实现风格化API文档

POM引入插件 <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId>  <version>2.0.3</version> </dependency> 配置加载 package com.p
教你利用springboot集成swagger并生成接口文档

效果图实现步骤 1.maven中引入jar包,不同版本的swagger可能页面效果不一样. <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.1</version> </dependency> <dependency> <groupId&g
将JavaDoc注释生成API文档的操作

目录将JavaDoc 注释生成API文档 java自动api文档生成Yapi word文档缺点 swwager文档缺点将JavaDoc 注释生成API文档 1. 打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号).普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/ 2. javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码. 3. 点

SpringBoot结合Swagger2自动生成api文档的方法

相关推荐

随机推荐