• swagger入门


    一、swagger

    1、配置pom.xml
    <dependency>
        <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.9.1.RELEASE</version>
    </dependency>
    
    2、开启swagger服务并配置application.yml
    @EnableSwagger2Doc
    @SpringBootApplication
    public class MyApplication {
        public static void main(String[] args) {
            SpringApplication.run(MyApplication.class, args);
        }
    }
    
    /********/
    
    swagger:
      title: 标题
      description: 描述
      exclude-path: /error # 剔除请求
    
    3、常用注解
    1、@Api:用在Controller类上,描述该类的作用
        * value:简要说明
        * description:详细描述该类的作用
    2、@ApiOperation:用在Controller请求方法上,描述方法的作用
    3、@ApiImplicitParams:用在请求方法上,对多个请求参数增加描述
    4、@ApiImplicitParam:可单独使用,或在@ApiImplicitParams中使用,给方法的一个请求参数增加描述
        * name:参数名
        * value:描述参数的作用
        * dataType:参数类型,默认String,其他值dataType="Integer"
        * defaultValue:参数默认值
        * required:参数是否必传(true/false)
        * paramType:指定参数放在哪些地方(header/query/path/body/form)
            header:参数在request headers里边提交@RequestHeader
            query:直接跟参数完成自动映射赋值@RequestParam
            path:以路径变量的形式提交数据@PathVariable
            body:以流的形式提交仅支持POST(不常用)
            form:以form表单的形式提交仅支持POST(不常用)
    5、@ApiModel:用在请求参数是对象上,描述该对象类的作用
    6、@ApiModelProperty:用在请求参数是对象的属性上,描述对象属性的作用
        * value:属性的描述
        * hidden:是否是查询条件属性。false:(默认值)在api文档显示,作为查询条件;true隐藏,不是条件属性
    
    4、访问
    ip:port/context-path/swagger-ui.html
    
  • 相关阅读:
    2-1 Restful中HTTP协议介绍
    11.修改WSDL文档
    10.TCPIP监听器
    05.使用jdk发布webservice服务
    09.ws复杂数据类型数据传输
    2019温馨的元旦祝福语 2019元旦祝福语大全!收藏备用!
    一文详解CSS常见的五大布局
    一文详解CSS常见的五大布局
    一文详解CSS常见的五大布局
    Asp.Net Core + Docker 搭建
  • 原文地址:https://www.cnblogs.com/linding/p/14823009.html
Copyright © 2020-2023  润新知