swagger简单集成

参考的github:https://github.com/SpringForAll/spring-boot-starter-swagger

  1. 引入maven:
 
     com.spring4all
     swagger-spring-boot-starter
     1.7.0.RELEASE
 
  1. 创建配置文件
# 具体含义解释见 https://github.com/SpringForAll/spring-boot-starter-swagger
spring.application.name=swagger-demo

#swagger.enabled=false

swagger.title=spring-boot-starter-swagger
swagger.description=Starter for swagger 2.x
swagger.version=1.1.0.RELEASE
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger

swagger.base-package=com.didispace

#swagger.ignored-parameter-types[0]=com.didispace.demo.User

swagger.global-operation-parameters[0].name=access_token
swagger.global-operation-parameters[0].description=user access token
swagger.global-operation-parameters[0].modelRef=string
swagger.global-operation-parameters[0].parameterType=header
swagger.global-operation-parameters[0].required=true

swagger.global-operation-parameters[1].name=timestamp
swagger.global-operation-parameters[1].description=access timestamp
swagger.global-operation-parameters[1].modelRef=int
swagger.global-operation-parameters[1].parameterType=header
swagger.global-operation-parameters[1].required=false

swagger.apply-default-response-messages=true
swagger.global-response-message.get[0].code=401
swagger.global-response-message.get[0].message=401get
swagger.global-response-message.get[1].code=500
swagger.global-response-message.get[1].message=500get
swagger.global-response-message.get[1].modelRef=ERROR

swagger.ui-config.json-editor=false
swagger.ui-config.show-request-headers=true
swagger.ui-config.request-timeout=5000
swagger.ui-config.submit-methods=get,delete
  1. 在启动类中添加@EnableSwagger2Doc注解
    swagger简单集成_第1张图片

  2. 在控制类中添加:@Api(value=“XXXcontroller”,description=“XXX接口”)

  3. 在方法上添加 @ApiIgnore:意思是不在页面上显示本接口。

  4. 在方法上添加 @ApiOperation(value=“XXX接口”,httpMethod=“POST”)。
    如图:
    swagger简单集成_第2张图片

  5. 最后重启项目,访问http://localhost:8080/swagger-ui.html#/auto-show-controller即可
    如图:
    swagger简单集成_第3张图片

如图显示,接口syncCrmAutoShow被屏蔽了,只显示了一个查询的接口
swagger简单集成_第4张图片

你可能感兴趣的:(java基础)