、启动springboot工程

8、如何设置Swagger在生产环境中使用在发布的时候不使用?

9、配置API文档分组

swagger是一个接口文档生成工具同时提供接口测试调用的辅助功能。

RestFul

--dependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger2/artifactIdversion2.9.2/version/dependency!--swagger-ui.html模式

--dependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger-ui/artifactIdversion2.9.2/version/dependency!--doc.html模式

--dependencygroupIdcom.github.xiaoymin/groupIdartifactIdswagger-bootstrap-ui/artifactIdversion1.9.2/version/dependency

3、编写一个Hellow工程

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

或者访问:http://localhost:8080/doc.html

6、配置swagger信息

Docket(DocumentationType.SWAGGER_2).apiInfo(new

ApiInfoBuilder().title(标题XX公司_XXXXX系统_接口文档).description(描述用于管理XXXXX,具体包括XXX,XXX模块...).contact(new

Contact(Socks,

null)).version(版本号:1.0).build()).select().apis(RequestHandlerSelectors.basePackage(kgc.cn)).paths(PathSelectors.any()).build();}}

方式二

{//配置swagger的Docket的bean实例Beanpublic

Docket

Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());}//配置swagger信息apiinfoprivate

ApiInfo

ApiInfo(swaggerAPI接口文档,辛勤铸就梦想付出就有回报。

,1.0,https://blog.csdn.net/qi341500?spm1000.2115.3001.5343,contact,Apache

2.0,http://www.apache.org/licenses/LICENSE-2.0,new

ArrayList());}

Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//

RequestHandlerselectors配置要扫描接口的方式//

any():扫描全部//none():不扫描//withclassAnnotation:扫描类上的注解参数是一个注解的反射对象//

withMethodAnnotation:扫描方法上的注解.apis(RequestHandlerSelectors.basePackage(cn.micro.myboot.controller))//paths()过滤路径.paths(PathSelectors.ant(/book/**)).build();}

Beanpublic

Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//enable是否启动Swagger如果为False则Swagger不能再浏览器中访问.enable(false).select().apis(RequestHandlerSelectors.basePackage(cn.micro.myboot.controller))//.paths(PathSelectors.ant(/book/**)).build();}

8、如何设置Swagger在生产环境中使用在发布的时候不使用?

false

Profiles.of(dev,test);//通过environment.acceptsProfiles判断是否处在自己设定的环境当中boolean

flag

environment.acceptsProfiles(profiles);return

new

Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//enable是否启动Swagger如果为False则Swagger不能再浏览器中访问.enable(flag).select().apis(RequestHandlerSelectors.basePackage(cn.micro.myboot.controller))//.paths(PathSelectors.ant(/book/**)).build();}

9、配置API文档分组

Profiles.of(dev,test);//通过environment.acceptsProfiles判断是否处在自己设定的环境当中boolean

flag

environment.acceptsProfiles(profiles);return

new

Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName(张三)//enable是否启动Swagger如果为False则Swagger不能再浏览器中访问.enable(flag).select().apis(RequestHandlerSelectors.basePackage(cn.micro.myboot.controller))//.paths(PathSelectors.ant(/book/**)).build();}

Beanpublic

Docket(DocumentationType.SWAGGER_2).groupName(A);}Beanpublic

Docket

Docket(DocumentationType.SWAGGER_2).groupName(B);}Beanpublic

Docket

Docket(DocumentationType.SWAGGER_2).groupName(C);}10、实体类配置

//只要接口中返回值存在实体类实体类就会被扫描到swagger中GetMapping(/user)public

User

实体类ApiModel()给实体类添加注释ApiModelProperty()给属性添加注释

Data

{ApiModelProperty(/用户id)private

String

uid;ApiModelProperty(/用户名)private

String

username;ApiModelProperty(/用户密码)private

String

ApiOperation(给方法添加注释)GetMapping(/user)public

User

ApiOperation(给方法添加注释)GetMapping(/user)public

User

{RequestMethod.GET,RequestMethod.POST})public

BaseResponseString

1、我们可以通过Swagger给一些比较难理解的属性或者接口增加注释信息

⒉、接口文档实时更新