springboot + swagger 实例代码

swagger用于定义api文档。

好处：

1. 前后端分离开发
2. api文档非常明确
3. 测试的时候不需要再使用url输入浏览器的方式来访问controller
4. 传统的输入url的测试方式对于post请求的传参比较麻烦（当然，可以使用postman这样的浏览器插件）
5. spring-boot与swagger的集成简单的一逼

1、项目结构

和上一节一样，没有改变。

2、pom.xml

引入了两个jar。

<dependency>
      <groupid>io.springfox</groupid>
      <artifactid>springfox-swagger2</artifactid>
      <version>2.2.2</version>
    </dependency>
    <dependency>
      <groupid>io.springfox</groupid>
      <artifactid>springfox-swagger-ui</artifactid>
      <version>2.2.2</version>
    </dependency>

3、application.java

package com.xxx.firstboot;

import org.springframework.boot.springapplication;
import org.springframework.boot.autoconfigure.springbootapplication;

import springfox.documentation.swagger2.annotations.enableswagger2;

@springbootapplication    //same as @configuration+@enableautoconfiguration+@componentscan
@enableswagger2       //启动swagger注解
public class application {

  public static void main(string[] args) {
    springapplication.run(application.class, args);
  }

}

说明：

引入了一个注解@enableswagger2来启动swagger注解。（启动该注解使得用在controller中的swagger注解生效，覆盖的范围由@componentscan的配置来指定，这里默认指定为根路径"com.xxx.firstboot"下的所有controller）

4、usercontroller.java

package com.xxx.firstboot.web;

import org.springframework.beans.factory.annotation.autowired;
import org.springframework.web.bind.annotation.requestheader;
import org.springframework.web.bind.annotation.requestmapping;
import org.springframework.web.bind.annotation.requestmethod;
import org.springframework.web.bind.annotation.requestparam;
import org.springframework.web.bind.annotation.restcontroller;

import com.xxx.firstboot.domain.user;
import com.xxx.firstboot.service.userservice;

import io.swagger.annotations.api;
import io.swagger.annotations.apiimplicitparam;
import io.swagger.annotations.apiimplicitparams;
import io.swagger.annotations.apioperation;
import io.swagger.annotations.apiresponse;
import io.swagger.annotations.apiresponses;

@restcontroller
@requestmapping("/user")
@api("usercontroller相关api")
public class usercontroller {

  @autowired
  private userservice userservice;
  
//  @autowired
//  private myredistemplate myredistemplate;

  @apioperation("获取用户信息")
  @apiimplicitparams({
    @apiimplicitparam(paramtype="header",name="username",datatype="string",required=true,value="用户的姓名",defaultvalue="zhaojigang"),
    @apiimplicitparam(paramtype="query",name="password",datatype="string",required=true,value="用户的密码",defaultvalue="wangna")
  })
  @apiresponses({
    @apiresponse(code=400,message="请求参数没填好"),
    @apiresponse(code=404,message="请求路径没有或页面跳转路径不对")
  })
  @requestmapping(value="/getuser",method=requestmethod.get)
  public user getuser(@requestheader("username") string username, @requestparam("password") string password) {
    return userservice.getuser(username,password);
  }
  
//  @requestmapping("/testjediscluster")
//  public user testjediscluster(@requestparam("username") string username){
//    string value = myredistemplate.get(myconstants.user_forward_cache_prefix, username);
//    if(stringutils.isblank(value)){
//      myredistemplate.set(myconstants.user_forward_cache_prefix, username, json.tojsonstring(getuser()));
//      return null;
//    }
//    return json.parseobject(value, user.class);
//  }
  
}

说明：
1、@api：用在类上，说明该类的作用

2、@apioperation：用在方法上，说明方法的作用

3、@apiimplicitparams：用在方法上包含一组参数说明

4、@apiimplicitparam：用在@apiimplicitparams注解中，指定一个请求参数的各个方面

   1、paramtype：参数放在哪个地方 header-->请求参数的获取：@requestheader

      ①query-->请求参数的获取：@requestparam

      ② path（用于restful接口）-->请求参数的获取：@pathvariable

      ③body（不常用）

      ④ form（不常用）

   2、name：参数名

   3、datatype：参数类型

   4、required：参数是否必须传

   5、value：参数的意思

   6、defaultvalue：参数的默认值

5、@apiresponses：用于表示一组响应

6、@apiresponse：用在@apiresponses中，一般用于表达一个错误的响应信息

   1、code：数字，例如400

   2、message：信息，例如"请求参数没填好"

   3、response：抛出异常的类

7、@apimodel：描述一个model的信息（这种一般用在post创建的时候，使用@requestbody这样的场景，请求参数无法使    

    1、@apiimplicitparam注解进行描述的时候） @apimodelproperty：描述一个model的属性

以上这些就是最常用的几个注解了。

需要注意的是：

apiimplicitparam这个注解不只是注解，还会影响运行期的程序，例子如下：

　　

如果apiimplicitparam中的phone的paramtype是query的话，是无法注入到rest路径中的，而且如果是path的话，是不需要配置apiimplicitparam的，即使配置了，其中的value="手机号"也不会在swagger-ui展示出来。

具体其他的注解，查看：https://github.com/swagger-api/swagger-core/wiki/annotations#apimodel

 测试：

启动服务，浏览器输入"http://localhost:8080/swagger-ui.html"

 

最上边一个红框：@api

get红框：method=requestmethod.get

右边红框：@apioperation

parameter红框：@apiimplicitparams系列注解

response messages红框：@apiresponses系列注解

输入参数后，点击"try it out!"，查看响应内容：

 

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