Spring Boot Swagger2使用方法過(guò)程解析

更新時(shí)間：2020年08月19日 15:00:06 作者：陶海軍

這篇文章主要介紹了Spring Boot Swagger2使用方法過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

1.添加Swagger2依賴

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.2.2</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.2.2</version>
</dependency>

2配置類(lèi)

@Configuration
@EnableSwagger2
public class Swagger2 {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.bs.swaggertest.controller"))
        .paths(PathSelectors.any())
        .build();
  }
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("微信項(xiàng)目接口對(duì)接文檔")
        .description("測(cè)試環(huán)境接口調(diào)試")
        .contact("陶海軍")
        .version("1.0")
        .build();
  }
}

3.添加文檔內(nèi)容

@RestController
@RequestMapping(value="/users")
public class UserController {
  @ApiOperation(value="刪除用戶", notes="根據(jù)url的id來(lái)指定刪除對(duì)象")
  @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "String")
  @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
  public String deleteUser(@PathVariable String id) {
    return "success";
  }
}

4.測(cè)試

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

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

相關(guān)文章

使用Spring?Retry實(shí)現(xiàn)業(yè)務(wù)異常重試
在系統(tǒng)中經(jīng)常遇到業(yè)務(wù)重試的邏輯,比如三方接口調(diào)用,timeout重試三遍,異常處理重試的兜底邏輯等,本文給大家介紹一下如何使用Spring?Retry優(yōu)雅的實(shí)現(xiàn)業(yè)務(wù)異常重試,需要的朋友可以參考下
2024-01-01
使用OkHttp3以Multipart/Form-Data方式上傳文件方式
在開(kāi)發(fā)過(guò)程中,使用multipart/form-data進(jìn)行圖片上傳是一個(gè)常見(jiàn)的需求,本文通過(guò)一個(gè)實(shí)際案例,講解了如何在項(xiàng)目中添加OkHttp3庫(kù)依賴,并使用multipart/form-data進(jìn)行圖片上傳,首先,介紹了ContentType的概念和常見(jiàn)類(lèi)型
2024-10-10
SpringCloud學(xué)習(xí)筆記之Feign遠(yuǎn)程調(diào)用
Feign是一個(gè)聲明式的http客戶端。其作用就是幫助我們優(yōu)雅的實(shí)現(xiàn)http請(qǐng)求的發(fā)送。本文將具體為大家介紹一下Feign的遠(yuǎn)程調(diào)用，感興趣的可以了解一下
2021-12-12
SpringBoot中使用Flyway進(jìn)行數(shù)據(jù)庫(kù)遷移的詳細(xì)流程
本文介紹了如何在Spring Boot項(xiàng)目中使用Flyway進(jìn)行數(shù)據(jù)庫(kù)遷移,Flyway通過(guò)SQL腳本管理數(shù)據(jù)庫(kù)變更,支持自動(dòng)執(zhí)行和版本控制,避免了手動(dòng)執(zhí)行SQL腳本的錯(cuò)誤和維護(hù)困難,需要的朋友可以參考下
2025-02-02
java 排序算法之歸并排序
本文主要講解了排序算法中的歸并排序，文中運(yùn)用大量的圖片和代碼講解的非常詳細(xì)，感興趣的朋友可以學(xué)習(xí)一下這篇文章，相信可以幫助到你
2021-09-09
為何找不到Java 7中的警告
在本篇文章和里小編給大家整理的是關(guān)于Java 7中的警告的相關(guān)知識(shí)點(diǎn)內(nèi)容，有需要的朋友們可以參考下。
2019-11-11
深入探究Java線程的創(chuàng)建與構(gòu)造方法
這篇文章主要給大家分享的是java線程的創(chuàng)建以及構(gòu)造方法，想了解具體方式的小伙伴可以參考下面文章內(nèi)容，希望對(duì)你有所幫助
2022-04-04
Java技巧分享之利用RxJava打造可觀測(cè)數(shù)據(jù)RxLiveData
這篇文章主要來(lái)和大家分享一個(gè)Java技巧，那就是利用RxJava打造可觀測(cè)數(shù)據(jù)RxLiveData，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以了解一下
2023-06-06
在springboot中使用注解將值注入?yún)?shù)的操作
這篇文章主要介紹了在springboot中使用注解將值注入?yún)?shù)的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧
2020-04-04
Java后端學(xué)習(xí)精華之TCP通信傳輸協(xié)議詳解
TCP/IP是一種面向連接的、可靠的、基于字節(jié)流的傳輸層通信協(xié)議，它會(huì)保證數(shù)據(jù)不丟包、不亂序。TCP全名是Transmission Control Protocol，它是位于網(wǎng)絡(luò)OSI模型中的第四層
2021-09-09