第一步:引入相關jar包:
<dependency>
????<groupId>io.springfox</groupId>
????<artifactId>springfox-swagger2</artifactId>
????<version>2.4.0</version>
?</dependency>
<dependency>
????<groupId>io.springfox</groupId>
????<artifactId>springfox-swagger-ui</artifactId>
????<version>2.4.0</version>
</dependency>
第二步:編寫swagger2的配置文件胰耗,這里可以配置swagger2的一些基本的內容凸椿,比如掃描的包等等
@Configuration
@EnableSwagger2
public class Swagger2 {
????/**
? ? * @Description:swagger2的配置文件趾代,這里可以配置swagger2的一些基本的內容板惑,比如掃描的包等等
? ? */
? ? @Bean
? ? public Docket createRestApi() {
????????// 為swagger添加header參數可供輸入
? ? ? ? ParameterBuilder userTokenHeader =new ParameterBuilder();
????????ParameterBuilder userIdHeader =new ParameterBuilder();
????????List pars =new ArrayList();
????????userTokenHeader.name("headerUserToken").description("userToken")
????????.modelRef(new ModelRef("string")).parameterType("header")
????????.required(false).build();
????????userIdHeader.name("headerUserId").description("userId")
????????.modelRef(new ModelRef("string")).parameterType("header")
????????.required(false).build();
????????pars.add(userTokenHeader.build());
????????pars.add(userIdHeader.build());
????????return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
????????.apis(RequestHandlerSelectors.basePackage("com.example.demo.Controller"))
????????.paths(PathSelectors.any()).build()
????????.globalOperationParameters(pars);
????}
????/**
? ? * @Description: 構建 api文檔的信息
? ? */
? ? private ApiInfo apiInfo() {
????????return new ApiInfoBuilder()
????????// 設置頁面標題
? ? ? ? ? ? ? ? .title("使用swagger2構建短視頻后端api接口文檔")
????????// 設置聯系人
? ? ? ?.contact(new Contact("imooc-風間影月","http://www.imooc.com","imooc@163.com"))
????????// 描述
? ? ? ?.description("歡迎訪問短視頻接口文檔东羹,這里是描述信息")
????????// 定義版本號
? ? ? ? .version("1.0").build();
????}
}
第三步:測試一下:
@RestController
@Api(value ="aaa", tags = {"這是玩的"})
public class DemoController {
????@ApiOperation(value ="方法", notes ="這是aa方法")
????@PostMapping("/aa")
????public Object bbb() {
????????return "aaaa";
}