blog的后端代码
view | history | commit | commitdiff
inleft
2022-02-09 9bcb19959eeb9da9bde2561e7278f6d0a55eb151
commit | author | age
9bcb19 1 /*
I 2 Copyright [2020] [https://www.xiaonuo.vip]
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8   http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15
16 Snowy采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
17
18 1.请不要删除和修改根目录下的LICENSE文件。
19 2.请不要删除和修改Snowy源码头部的版权声明。
20 3.请保留源码和相关描述文件的项目出处，作者声明等。
21 4.分发源码时候，请注明软件出处 https://gitee.com/xiaonuobase/snowy
22 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/xiaonuobase/snowy
23 6.若您的项目无法满足以上几点，可申请商业授权，获取Snowy商业授权许可，请在官网购买授权，地址为 https://www.xiaonuo.vip
24  */
25 package vip.xiaonuo.sys.config;
26
27 import cn.hutool.core.collection.CollectionUtil;
28 import org.springframework.context.annotation.Bean;
29 import org.springframework.context.annotation.Configuration;
30 import springfox.documentation.builders.ApiInfoBuilder;
31 import springfox.documentation.builders.ParameterBuilder;
32 import springfox.documentation.builders.PathSelectors;
33 import springfox.documentation.builders.RequestHandlerSelectors;
34 import springfox.documentation.schema.ModelRef;
35 import springfox.documentation.service.ApiInfo;
36 import springfox.documentation.service.Contact;
37 import springfox.documentation.service.Parameter;
38 import springfox.documentation.spi.DocumentationType;
39 import springfox.documentation.spring.web.plugins.Docket;
40 import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
41 import vip.xiaonuo.core.consts.CommonConstant;
42
43 import java.util.List;
44
45 /**
46  * swagger配置
47  *
48  * @author xuyuxiang
49  * 加入分组功能(默认注释掉)
50  * <p>
51  * https://doc.xiaominfo.com/knife4j/changelog/2017-12-18-swagger-bootstrap-ui-1.7-issue.html
52  * </p>
53  * @author ldw4033#163.com
54  * @date 2021/4/9 10:42
55  **/
56 @Configuration
57 @EnableSwagger2WebMvc
58 public class SwaggerConfig {
59
60     private List<Parameter> getParameters() {
61         Parameter parameter = new ParameterBuilder()
62                 .name("Authorization")
63                 .description("token令牌")
64                 .modelRef(new ModelRef("string"))
65                 .parameterType("header")
66                 .required(false)
67                 .build();
68
69         List<Parameter> parameters = CollectionUtil.newArrayList();
70         parameters.add(parameter);
71         return parameters;
72     }
73
74     @Bean
75     public Docket defaultApi() {
76         List<Parameter> parameters = getParameters();
77         return new Docket(DocumentationType.SWAGGER_2)
78                 .apiInfo(defaultApiInfo())
79                 .groupName("默认接口")
80                 .select()
81                 .apis(RequestHandlerSelectors.basePackage(CommonConstant.DEFAULT_PACKAGE_NAME))
82                 .paths(PathSelectors.any())
83                 .build()
84                 .globalOperationParameters(parameters);
85     }
86
87     private ApiInfo defaultApiInfo() {
88         return new ApiInfoBuilder()
89                 .title("Snowy Doc")
90                 .description("Snowy Doc文档")
91                 .termsOfServiceUrl("https://www.xiaonuo.vip")
92                 .contact(new Contact("xuyuxiang, yubaoshan, dongxiayu", "https://www.xiaonuo.vip", ""))
93                 .version("1.0")
94                 .build();
95     }
96
97     /**
98      * 想分组请放开注释
99      */
100
101     // @Bean
102     // public Docket groupRestApi() {
103     //     List<Parameter> parameters = getParameters();
104     //     return new Docket(DocumentationType.SWAGGER_2)
105     //             .apiInfo(groupApiInfo())
106     //             .groupName("自定义")
107     //             .select()
108     //             //TODO 这里改为自己的包名
109     //             .apis(RequestHandlerSelectors.basePackage("com.example.XXX"))
110     //             .paths(PathSelectors.any())
111     //             .build()
112     //             .globalOperationParameters(parameters);
113     // }
114     //
115     // private ApiInfo groupApiInfo() {
116     //     return new ApiInfoBuilder()
117     //             .title("自定义")
118     //             .description("自定义API")
119     //             .termsOfServiceUrl("http://www.example.com/")
120     //             .version("1.0")
121     //             .build();
122     // }
123
124 }